Vert.x 4.5.13 · io.vertx.core.http.impl.HttpClientStream

Method Summary

Modifier and Type	Method and Description
public void	chunkHandler(Handler<Buffer> handler)
public void	closeHandler(Handler<Void> handler)
public HttpClientConnection	connection()
public void	continueHandler(Handler<Void> handler)
public void	doFetch(long amount)
public void	doPause()
public void	doSetWriteQueueMaxSize(int size)
public void	earlyHintsHandler(Handler<MultiMap> handler)
public default Future<Void>	end(Buffer the data to write data) Overrides default io.vertx.core.streams.WriteStream.end. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Same as `end()` but writes some data to the stream before ending.
public default void	end(Buffer data, Handler<AsyncResult<Void>> handler) Overrides default io.vertx.core.streams.WriteStream.end. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Same as `end(T)` but with an `handler` called when the operation completes
public default Future<Void>	end() Overrides default io.vertx.core.streams.WriteStream.end. Ends the stream.
public default void	end(Handler<AsyncResult<Void>> handler) Overrides default io.vertx.core.streams.WriteStream.end. Implements io.vertx.core.streams.WriteStream.end. Same as `end()` but with an `handler` called when the operation completes
public void	endHandler(Handler<MultiMap> handler)
public ContextInternal	getContext()
public void	headHandler(Handler<HttpResponseHead> handler)
public int	Returns: the stream id, `1` denotes the first stream, HTTP/1 is a simple sequence, HTTP/2 is the actual stream identifier. id()
public boolean	isNotWritable()
public Object	metric()
public StreamPriority	priority()
public void	priorityHandler(Handler<StreamPriority> handler)
public void	pushHandler(Handler<HttpClientPush> handler)
public void	reset(Throwable cause)
public Object	trace()
public void	unknownFrameHandler(Handler<HttpFrame> handler)
public void	updatePriority(StreamPriority streamPriority)
public HttpVersion	Returns: the stream version or null if it's not yet determined version()
public default Future<Void>	write(Buffer the data to write data) Implements io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Write some data to the stream.
public default void	write(Buffer data, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Same as `write(T)` but with an `handler` called when the operation completes
public void	writeBuffer(ByteBuf buf, boolean end, Handler<AsyncResult<Void>> listener)
public void	writeFrame(int type, int flags, ByteBuf payload)
public void	writeHead(HttpRequestHead request, boolean chunked, ByteBuf buf, boolean end, StreamPriority priority, boolean connect, Handler<AsyncResult<Void>> handler)

Inherited from io.vertx.core.streams.WriteStream:: drainHandler exceptionHandler setWriteQueueMaxSize writeQueueFull

Method Detail

chunkHandler	back to summary
public void chunkHandler(Handler<Buffer> handler)

closeHandler	back to summary
public void closeHandler(Handler<Void> handler)

connection	back to summary
public HttpClientConnection connection()

continueHandler	back to summary
public void continueHandler(Handler<Void> handler)

doFetch	back to summary
public void doFetch(long amount)

doPause	back to summary
public void doPause()

doSetWriteQueueMaxSize	back to summary
public void doSetWriteQueueMaxSize(int size)

earlyHintsHandler	back to summary
public void earlyHintsHandler(Handler<MultiMap> handler)

end back to summary

end	back to summary
public default Future<Void> end(Buffer data) Overrides default io.vertx.core.streams.WriteStream.end. Doc from io.vertx.core.streams.WriteStream.end. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Same as `end()` but writes some data to the stream before ending. Parameters data:Buffer the data to write Returns:Future<Void> a future completed with the result Annotations @Override

public default Future<Void> end(Buffer data)

Overrides default io.vertx.core.streams.WriteStream.end.

Doc from io.vertx.core.streams.WriteStream.end.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Same as end() but writes some data to the stream before ending.

Parameters

data:Buffer: the data to write

Returns:Future<Void>

a future completed with the result

Annotations

@Override

end back to summary

end	back to summary
public default void end(Buffer data, Handler<AsyncResult<Void>> handler) Overrides default io.vertx.core.streams.WriteStream.end. Doc from io.vertx.core.streams.WriteStream.end. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Same as `end(T)` but with an `handler` called when the operation completes Annotations @Override

public default void end(Buffer data, Handler<AsyncResult<Void>> handler)

Overrides default io.vertx.core.streams.WriteStream.end.

Doc from io.vertx.core.streams.WriteStream.end.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Same as end(T) but with an handler called when the operation completes

Annotations

@Override

end	back to summary
public default Future<Void> end() Overrides default io.vertx.core.streams.WriteStream.end. Doc from io.vertx.core.streams.WriteStream.end. Ends the stream. Once the stream has ended, it cannot be used any more. Returns:Future<Void> a future completed with the result Annotations @Override

end

back to summary

public default Future<Void> end()

Overrides default io.vertx.core.streams.WriteStream.end.

Doc from io.vertx.core.streams.WriteStream.end.

Ends the stream.

Once the stream has ended, it cannot be used any more.

Returns:Future<Void>

a future completed with the result

Annotations

@Override

end back to summary

end	back to summary
public default void end(Handler<AsyncResult<Void>> handler) Overrides default io.vertx.core.streams.WriteStream.end. Implements io.vertx.core.streams.WriteStream.end. Doc from io.vertx.core.streams.WriteStream.end. Same as `end()` but with an `handler` called when the operation completes Annotations @Override

public default void end(Handler<AsyncResult<Void>> handler)

Overrides default io.vertx.core.streams.WriteStream.end.

Implements io.vertx.core.streams.WriteStream.end.

Doc from io.vertx.core.streams.WriteStream.end.

Same as end() but with an handler called when the operation completes

Annotations

@Override

endHandler	back to summary
public void endHandler(Handler<MultiMap> handler)

getContext	back to summary
public ContextInternal getContext()

headHandler	back to summary
public void headHandler(Handler<HttpResponseHead> handler)

id	back to summary
public int id() Returns:int the stream id, `1` denotes the first stream, HTTP/1 is a simple sequence, HTTP/2 is the actual stream identifier.

isNotWritable	back to summary
public boolean isNotWritable()

metric	back to summary
public Object metric()

priority	back to summary
public StreamPriority priority()

priorityHandler	back to summary
public void priorityHandler(Handler<StreamPriority> handler)

pushHandler	back to summary
public void pushHandler(Handler<HttpClientPush> handler)

reset	back to summary
public void reset(Throwable cause)

trace	back to summary
public Object trace()

unknownFrameHandler	back to summary
public void unknownFrameHandler(Handler<HttpFrame> handler)

updatePriority	back to summary
public void updatePriority(StreamPriority streamPriority)

version	back to summary
public HttpVersion version() Returns:HttpVersion the stream version or null if it's not yet determined

write back to summary

write	back to summary
public default Future<Void> write(Buffer data) Implements io.vertx.core.streams.WriteStream.write. Doc from io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Write some data to the stream. The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the `writeQueueFull` method before writing. This is done automatically if using a `Pipe`. When the `data` is moved from the queue to the actual medium, the returned `Future` will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write. Parameters data:Buffer the data to write Returns:Future<Void> a future completed with the write result Annotations @Override

public default Future<Void> write(Buffer data)

Implements io.vertx.core.streams.WriteStream.write.

Doc from io.vertx.core.streams.WriteStream.write.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Write some data to the stream.

The data is usually put on an internal write queue, and the write actually happens asynchronously. To avoid running out of memory by putting too much on the write queue, check the writeQueueFull method before writing. This is done automatically if using a Pipe.

When the data is moved from the queue to the actual medium, the returned Future will be completed with the write result, e.g the future is succeeded when a server HTTP response buffer is written to the socket and failed if the remote client has closed the socket while the data was still pending for write.

Parameters

data:Buffer: the data to write

Returns:Future<Void>

a future completed with the write result

Annotations

@Override

write back to summary

write	back to summary
public default void write(Buffer data, Handler<AsyncResult<Void>> handler) Implements io.vertx.core.streams.WriteStream.write. Doc from io.vertx.core.streams.WriteStream.write. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Same as `write(T)` but with an `handler` called when the operation completes Annotations @Override

public default void write(Buffer data, Handler<AsyncResult<Void>> handler)

Implements io.vertx.core.streams.WriteStream.write.

Doc from io.vertx.core.streams.WriteStream.write.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Same as write(T) but with an handler called when the operation completes

Annotations

@Override

writeBuffer	back to summary
public void writeBuffer(ByteBuf buf, boolean end, Handler<AsyncResult<Void>> listener)

writeFrame	back to summary
public void writeFrame(int type, int flags, ByteBuf payload)

writeHead	back to summary
public void writeHead(HttpRequestHead request, boolean chunked, ByteBuf buf, boolean end, StreamPriority priority, boolean connect, Handler<AsyncResult<Void>> handler)

public Interface HttpClientStream

Method Summary

Method Detail