Vert.x 4.5.13 · io.vertx.core.streams.impl.PipeImpl · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	PipeImpl.WriteException

Modifier and Type	Field and Description
private WriteStream<T>	dst
private boolean	endOnFailure
private boolean	endOnSuccess
private final Promise<Void>	result
private final ReadStream<T>	src

Access	Constructor and Description
public	PipeImpl(ReadStream<T> src)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements io.vertx.core.streams.Pipe.close. Close the pipe.
public synchronized Pipe<T>	endOnComplete(boolean `true` to end the stream on a source `ReadStream` completion end) Implements io.vertx.core.streams.Pipe.endOnComplete. Set to `true` to call `WriteStream#end()` when the source `ReadStream` completes, `false` otherwise.
public synchronized Pipe<T>	endOnFailure(boolean `true` to end the stream on a source `ReadStream` failure end) Implements io.vertx.core.streams.Pipe.endOnFailure. Set to `true` to call `WriteStream#end()` when the source `ReadStream` fails, `false` otherwise.
public synchronized Pipe<T>	endOnSuccess(boolean `true` to end the stream on a source `ReadStream` success end) Implements io.vertx.core.streams.Pipe.endOnSuccess. Set to `true` to call `WriteStream#end()` when the source `ReadStream` succeeds, `false` otherwise.
private void	handleFailure(Throwable cause, Handler<AsyncResult<Void>> completionHandler)
private void	handleSuccess(Handler<AsyncResult<Void>> completionHandler)
private void	handleWriteResult(AsyncResult<Void> ack)
public void	to(WriteStream<T> the destination write stream ws, Handler<AsyncResult<Void>> the handler called when the pipe operation completes completionHandler) Implements io.vertx.core.streams.Pipe.to. Start to pipe the elements to the destination `WriteStream`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

dst	back to summary
private WriteStream<T> dst

endOnFailure	back to summary
private boolean endOnFailure

endOnSuccess	back to summary
private boolean endOnSuccess

result	back to summary
private final Promise<Void> result

src	back to summary
private final ReadStream<T> src

PipeImpl	back to summary
public PipeImpl(ReadStream<T> src)

Method Detail

close	back to summary
public void close() Implements io.vertx.core.streams.Pipe.close. Doc from io.vertx.core.streams.Pipe.close. Close the pipe. The streams handlers will be unset and the read stream resumed unless it is already ended.

back to summary

public void close()

Implements io.vertx.core.streams.Pipe.close.

Doc from io.vertx.core.streams.Pipe.close.

Close the pipe.

The streams handlers will be unset and the read stream resumed unless it is already ended.

endOnComplete back to summary

endOnComplete	back to summary
public synchronized Pipe<T> endOnComplete(boolean end) Implements io.vertx.core.streams.Pipe.endOnComplete. Doc from io.vertx.core.streams.Pipe.endOnComplete. Set to `true` to call `WriteStream#end()` when the source `ReadStream` completes, `false` otherwise. Calling this overwrites `endOnFailure` and `endOnSuccess`. Parameters end:boolean `true` to end the stream on a source `ReadStream` completion Returns:Pipe<T> a reference to this, so the API can be used fluently Annotations @Override

public synchronized Pipe<T> endOnComplete(boolean end)

Implements io.vertx.core.streams.Pipe.endOnComplete.

Doc from io.vertx.core.streams.Pipe.endOnComplete.

Set to true to call WriteStream#end() when the source ReadStream completes, false otherwise.

Calling this overwrites endOnFailure and endOnSuccess.

Parameters

end:boolean: true to end the stream on a source ReadStream completion

Returns:Pipe<T>

a reference to this, so the API can be used fluently

Annotations

@Override

endOnFailure back to summary

endOnFailure	back to summary
public synchronized Pipe<T> endOnFailure(boolean end) Implements io.vertx.core.streams.Pipe.endOnFailure. Doc from io.vertx.core.streams.Pipe.endOnFailure. Set to `true` to call `WriteStream#end()` when the source `ReadStream` fails, `false` otherwise. Parameters end:boolean `true` to end the stream on a source `ReadStream` failure Returns:Pipe<T> a reference to this, so the API can be used fluently Annotations @Override

public synchronized Pipe<T> endOnFailure(boolean end)

Implements io.vertx.core.streams.Pipe.endOnFailure.

Doc from io.vertx.core.streams.Pipe.endOnFailure.

Set to true to call WriteStream#end() when the source ReadStream fails, false otherwise.

Parameters

end:boolean: true to end the stream on a source ReadStream failure

Returns:Pipe<T>

a reference to this, so the API can be used fluently

Annotations

@Override

endOnSuccess back to summary

endOnSuccess	back to summary
public synchronized Pipe<T> endOnSuccess(boolean end) Implements io.vertx.core.streams.Pipe.endOnSuccess. Doc from io.vertx.core.streams.Pipe.endOnSuccess. Set to `true` to call `WriteStream#end()` when the source `ReadStream` succeeds, `false` otherwise. Parameters end:boolean `true` to end the stream on a source `ReadStream` success Returns:Pipe<T> a reference to this, so the API can be used fluently Annotations @Override

public synchronized Pipe<T> endOnSuccess(boolean end)

Implements io.vertx.core.streams.Pipe.endOnSuccess.

Doc from io.vertx.core.streams.Pipe.endOnSuccess.

Set to true to call WriteStream#end() when the source ReadStream succeeds, false otherwise.

Parameters

end:boolean: true to end the stream on a source ReadStream success

Returns:Pipe<T>

a reference to this, so the API can be used fluently

Annotations

@Override

handleFailure	back to summary
private void handleFailure(Throwable cause, Handler<AsyncResult<Void>> completionHandler)

handleSuccess	back to summary
private void handleSuccess(Handler<AsyncResult<Void>> completionHandler)

handleWriteResult	back to summary
private void handleWriteResult(AsyncResult<Void> ack)

to back to summary

to	back to summary
public void to(WriteStream<T> ws, Handler<AsyncResult<Void>> completionHandler) Implements io.vertx.core.streams.Pipe.to. Doc from io.vertx.core.streams.Pipe.to. Start to pipe the elements to the destination `WriteStream`. When the operation fails with a write error, the source stream is resumed. Parameters ws:WriteStream<T> the destination write stream completionHandler:Handler<AsyncResult<Void>> the handler called when the pipe operation completes Annotations @Override

public void to(WriteStream<T> ws, Handler<AsyncResult<Void>> completionHandler)

Implements io.vertx.core.streams.Pipe.to.

Doc from io.vertx.core.streams.Pipe.to.

Start to pipe the elements to the destination WriteStream.

When the operation fails with a write error, the source stream is resumed.

Parameters

ws:WriteStream<T>: the destination write stream
completionHandler:Handler<AsyncResult<Void>>: the handler called when the pipe operation completes

Annotations

@Override

public Class PipeImpl<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PipeImpl.WriteException

Constructor Summary

Constructor Detail