raboof/pekko
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions 10

Fix #23165: Update StreamConverters.fromInputStream docs to reflect reality

Browse source
This commit is contained in:
Jan Ypma 2017-07-26 12:08:17 +02:00 • committed by Johan Andrén
parent 7d822cc7d5
commit 7b7749cd7b
2 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
akka-stream/src/main/scala/akka/stream/javadsl/StreamConverters.scala
View file

@ -89,8 +89,10 @@ object StreamConverters {
/**
* Creates a Source from an [[java.io.InputStream]] created by the given function.
* Emitted elements are `chunkSize` sized [[akka.util.ByteString]] elements,
* except the final element, which will be up to `chunkSize` in size.
* Emitted elements are up to `chunkSize` sized [[akka.util.ByteString]] elements.
* The actual size of emitted elements depends how much data the underlying
* [[java.io.InputStream]] returns on each read invocation. Such chunks will
* never be larger than chunkSize though.
*
* You can configure the default dispatcher for this Source by changing the `akka.stream.blocking-io-dispatcher` or
* set it for a given Source by using [[akka.stream.ActorAttributes]].
@ -104,8 +106,10 @@ object StreamConverters {
/**
* Creates a Source from an [[java.io.InputStream]] created by the given function.
* Emitted elements are [[ByteString]] elements, chunked by default by 8192 bytes,
* except the last element, which will be up to 8192 in size.
* Emitted elements are up to 8192 bytes sized [[akka.util.ByteString]] elements.
* The actual size of emitted elements depends how much data the underlying
* [[java.io.InputStream]] returns on each read invocation. Such chunks will
* never be larger than chunkSize though.
*
* You can configure the default dispatcher for this Source by changing the `akka.stream.blocking-io-dispatcher` or
* set it for a given Source by using [[akka.stream.ActorAttributes]].

6
akka-stream/src/main/scala/akka/stream/scaladsl/StreamConverters.scala
View file

@ -29,8 +29,10 @@ object StreamConverters {
/**
* Creates a Source from an [[InputStream]] created by the given function.
* Emitted elements are `chunkSize` sized [[akka.util.ByteString]] elements,
* except the final element, which will be up to `chunkSize` in size.
* Emitted elements are up to `chunkSize` sized [[akka.util.ByteString]] elements.
* The actual size of emitted elements depends how much data the underlying
* [[java.io.InputStream]] returns on each read invocation. Such chunks will
* never be larger than chunkSize though.
*
* You can configure the default dispatcher for this Source by changing the `akka.stream.blocking-io-dispatcher` or
* set it for a given Source by using [[akka.stream.ActorAttributes]].