Http2FrameWriter instance.
| Modifier and Type | Field and Description |
|---|---|
| private final Http2FrameWriter |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public void | close()
Implements io. |
| public Http2FrameWriter. | configuration()
Implements io. Http2FrameWriter
|
| public ChannelFuture | writeData(ChannelHandlerContext
the context to use for writing. ctx, int the stream for which to send the frame. streamId, ByteBuf the payload of the frame. This will be released by this method. data, int additional bytes that should be added to obscure the true content size. Must be between 0 and
256 (inclusive). A 1 byte padding is encoded as just the pad length field with value 0.
A 256 byte padding is encoded as the pad length field with value 255 and 255 padding bytes
appended to the end of the frame. padding, boolean indicates if this is the last frame to be sent for the stream. endStream, ChannelPromise the promise for the write. promise)Implements io. DATA frame to the remote endpoint.
|
| public ChannelFuture | writeFrame(ChannelHandlerContext
the context to use for writing. ctx, byte the frame type identifier. frameType, int the stream for which to send the frame. streamId, Http2Flags the flags to write for this frame. flags, ByteBuf the payload to write for this frame. This will be released by this method. payload, ChannelPromise the promise for the write. promise)Implements io. |
| public ChannelFuture | writeGoAway(ChannelHandlerContext
the context to use for writing. ctx, int the last known stream of this endpoint. lastStreamId, long the error code, if the connection was abnormally terminated. errorCode, ByteBuf application-defined debug data. This will be released by this method. debugData, ChannelPromise the promise for the write. promise)Implements io. |
| public ChannelFuture | writeHeaders(ChannelHandlerContext
the context to use for writing. ctx, int the stream for which to send the frame. streamId, Http2Headers the headers to be sent. headers, int additional bytes that should be added to obscure the true content size. Must be between 0 and
256 (inclusive). padding, boolean indicates if this is the last frame to be sent for the stream. endStream, ChannelPromise the promise for the write. promise)Implements io. |
| public ChannelFuture | writeHeaders(ChannelHandlerContext
the context to use for writing. ctx, int the stream for which to send the frame. streamId, Http2Headers the headers to be sent. headers, int the stream on which this stream should depend, or 0 if it should
depend on the connection. streamDependency, short the weight for this stream. weight, boolean whether this stream should be the exclusive dependant of its parent. exclusive, int additional bytes that should be added to obscure the true content size. Must be between 0 and
256 (inclusive). padding, boolean indicates if this is the last frame to be sent for the stream. endStream, ChannelPromise the promise for the write. promise)Implements io. |
| public ChannelFuture | writePing(ChannelHandlerContext
the context to use for writing. ctx, boolean indicates whether this is an ack of a PING frame previously received from the
remote endpoint. ack, long the payload of the frame. data, ChannelPromise the promise for the write. promise)Implements io. |
| public ChannelFuture | writePriority(ChannelHandlerContext
the context to use for writing. ctx, int the stream for which to send the frame. streamId, int the stream on which this stream should depend, or 0 if it should
depend on the connection. streamDependency, short the weight for this stream. weight, boolean whether this stream should be the exclusive dependant of its parent. exclusive, ChannelPromise the promise for the write. promise)Implements io. |
| public ChannelFuture | writePushPromise(ChannelHandlerContext
the context to use for writing. ctx, int the stream for which to send the frame. streamId, int the ID of the promised stream. promisedStreamId, Http2Headers the headers to be sent. headers, int additional bytes that should be added to obscure the true content size. Must be between 0 and
256 (inclusive). padding, ChannelPromise the promise for the write. promise)Implements io. |
| public ChannelFuture | writeRstStream(ChannelHandlerContext
the context to use for writing. ctx, int the stream for which to send the frame. streamId, long the error code indicating the nature of the failure. errorCode, ChannelPromise the promise for the write. promise)Implements io. |
| public ChannelFuture | writeSettings(ChannelHandlerContext
the context to use for writing. ctx, Http2Settings the settings to be sent. settings, ChannelPromise the promise for the write. promise)Implements io. |
| public ChannelFuture | writeSettingsAck(ChannelHandlerContext
the context to use for writing. ctx, ChannelPromise the promise for the write. promise)Implements io. |
| public ChannelFuture | writeWindowUpdate(ChannelHandlerContext
the context to use for writing. ctx, int the stream for which to send the frame. streamId, int the number of bytes by which the local inbound flow control window
is increasing. windowSizeIncrement, ChannelPromise the promise for the write. promise)Implements io. |
| delegate | back to summary |
|---|---|
| private final Http2FrameWriter delegate | |
| DecoratingHttp2FrameWriter | back to summary |
|---|---|
| public DecoratingHttp2FrameWriter(Http2FrameWriter delegate) | |
| close | back to summary |
|---|---|
| public void close() Implements io. Doc from io. Closes this writer and frees any allocated resources.
| |
| configuration | back to summary |
|---|---|
| public Http2FrameWriter. Implements io. Doc from io. Get the configuration related elements for this
| |
| writeData | back to summary |
|---|---|
| public ChannelFuture writeData(ChannelHandlerContext ctx, int streamId, ByteBuf data, int padding, boolean endStream, ChannelPromise promise) Implements io. Doc from io. Writes a
| |
| writeFrame | back to summary |
|---|---|
| public ChannelFuture writeFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, ByteBuf payload, ChannelPromise promise) Implements io. Doc from io. Generic write method for any HTTP/2 frame. This allows writing of non-standard frames.
| |
| writeGoAway | back to summary |
|---|---|
| public ChannelFuture writeGoAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise) Implements io. Doc from io. Writes a GO_AWAY frame to the remote endpoint.
| |
| writeHeaders | back to summary |
|---|---|
| public ChannelFuture writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, ChannelPromise promise) Implements io. Doc from io. Writes a HEADERS frame to the remote endpoint.
| |
| writeHeaders | back to summary |
|---|---|
| public ChannelFuture writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endStream, ChannelPromise promise) Implements io. Doc from io. Writes a HEADERS frame with priority specified to the remote endpoint.
| |
| writePing | back to summary |
|---|---|
| public ChannelFuture writePing(ChannelHandlerContext ctx, boolean ack, long data, ChannelPromise promise) Implements io. Doc from io. Writes a PING frame to the remote endpoint.
| |
| writePriority | back to summary |
|---|---|
| public ChannelFuture writePriority(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive, ChannelPromise promise) Implements io. Doc from io. Writes a PRIORITY frame to the remote endpoint.
| |
| writePushPromise | back to summary |
|---|---|
| public ChannelFuture writePushPromise(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding, ChannelPromise promise) Implements io. Doc from io. Writes a PUSH_PROMISE frame to the remote endpoint.
| |
| writeRstStream | back to summary |
|---|---|
| public ChannelFuture writeRstStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise) Implements io. Doc from io. Writes a RST_STREAM frame to the remote endpoint.
| |
| writeSettings | back to summary |
|---|---|
| public ChannelFuture writeSettings(ChannelHandlerContext ctx, Http2Settings settings, ChannelPromise promise) Implements io. Doc from io. Writes a SETTINGS frame to the remote endpoint.
| |
| writeSettingsAck | back to summary |
|---|---|
| public ChannelFuture writeSettingsAck(ChannelHandlerContext ctx, ChannelPromise promise) Implements io. Doc from io. Writes a SETTINGS acknowledgment to the remote endpoint.
| |
| writeWindowUpdate | back to summary |
|---|---|
| public ChannelFuture writeWindowUpdate(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement, ChannelPromise promise) Implements io. Doc from io. Writes a WINDOW_UPDATE frame to the remote endpoint.
| |