BufferedPipe
Related Doc:
package streaming
Iterate through all buffered items, removing any where the provided function returns true
Link this source to a sink.
Link this source to a sink. Items will be pulled from the source and
pushed to the sink, respecting backpressure, until either the source is
closed or an error occurs. The linkClosed and linkTerminated
parameters determine whether to propagate closure/termination of this
Source to the linked Sink. However if the sink is closed or terminated first, this
source will be terminated.
The sink to link to this source
if true, the linked sink will be closed when this source is closed
if true, the linked sink will be terminated when this source is terminated
Pull the next item from the Source if available.
Pull the next item from the Source if available. The returned PullResult will indicate whether an item was successfully pulled.
Pull until either the supplied function returns false or there are no more
items immediately available to pull, in which case a Some[NullPullResult]
is returned indicating why the loop stopped.
Pull until either the supplied function returns false or there are no more
items immediately available to pull, in which case a Some[NullPullResult]
is returned indicating why the loop stopped.
Repeatedly pull items out of a pipe, even if items are not immediately available.
Repeatedly pull items out of a pipe, even if items are not immediately
available. The Source will hold onto the given processing function and
immediately forward items into it as they become available. The returned
PullAction determines how the Source will proceed with the next item.
If PullContinue or Wait are returned, the Source will hold onto the
processing function for either when the next item is available or when the
returned Signal is fired. onComplete is only called if the Source is
closed or terminated while the processing function is in use.
When Wait is returned, the item that was passed into the processing
function is _not_ pulled from the source. Thus when the returned signal is
fired and processing resumes, the same item will be passed to the
processing function.
This method is generally intended for linking the output of a Source to
the input of a Sink. For a simplified version of this functionality, see
Source.into.
Attempt to push a value into the pipe.
Attempt to push a value into the pipe.
The value will only be successfully pushed only if there has already a been a request for data on the pulling side. In other words, the pipe will never interally queue a value.
the result of the push
Immediately terminate the transport, permenantly putting it into an error state
Immediately terminate the transport, permenantly putting it into an error state
A pipe backed by a fixed-length buffer. Items can be pushed into the buffer until it fills, at which point the
FullPushResult is returned. When items are pulled out of the pipe the signal return in the Full result is fired.The most efficient way to use a
BufferedPipeis with thepullWhilemethod. This allows the pipe to completely bypass buffering and items pushed to the pipe are fast-tracked directly into the provided processing function.