public interface Pipe<T>
ReadStream
to a WriteStream
and performs flow control where necessary to
prevent the write stream buffer from getting overfull.
Instances of this class read items from a ReadStream
and write them to a WriteStream
. If data
can be read faster than it can be written this could result in the write queue of the WriteStream
growing
without bound, eventually causing it to exhaust all available RAM.
To prevent this, after each write, instances of this class check whether the write queue of the WriteStream
is full, and if so, the ReadStream
is paused, and a drainHandler
is set on the
WriteStream
.
When the WriteStream
has processed half of its backlog, the drainHandler
will be
called, which results in the pump resuming the ReadStream
.
This class can be used to pipe from any ReadStream
to any WriteStream
,
e.g. from an HttpServerRequest
to an AsyncFile
,
or from NetSocket
to a WebSocket
.
Please see the documentation for more information.
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the pipe.
|
Pipe<T> |
endOnComplete(boolean end)
|
Pipe<T> |
endOnFailure(boolean end)
|
Pipe<T> |
endOnSuccess(boolean end)
|
void |
to(WriteStream<T> dst)
Like
to(WriteStream, Handler) but without a completion handler |
void |
to(WriteStream<T> dst,
Handler<AsyncResult<Void>> completionHandler)
Start to pipe the elements to the destination
WriteStream . |
Pipe<T> endOnFailure(boolean end)
end
- true
to end the stream on a source ReadStream
failurePipe<T> endOnSuccess(boolean end)
end
- true
to end the stream on a source ReadStream
successPipe<T> endOnComplete(boolean end)
true
to call WriteStream.end()
when the source ReadStream
completes, false
otherwise.
Calling this overwrites endOnFailure(boolean)
and endOnSuccess(boolean)
.
end
- true
to end the stream on a source ReadStream
completionvoid to(WriteStream<T> dst)
to(WriteStream, Handler)
but without a completion handlervoid to(WriteStream<T> dst, Handler<AsyncResult<Void>> completionHandler)
WriteStream
.
When the operation fails with a write error, the source stream is resumed.
dst
- the destination write streamcompletionHandler
- the handler called when the pipe operation completesvoid close()
The streams handlers will be unset and the read stream resumed unless it is already ended.
Copyright © 2023 Eclipse. All rights reserved.