Netty/Codec/HTTP2 4.1.107.Final · io.netty.handler.codec.http2.Http2FrameWriter

Modifier and Type	Class and Description
public static interface	Http2FrameWriter.Configuration Configuration specific to `Http2FrameWriter`

Method Summary

Modifier and Type	Method and Description
public void	close() Redeclares java.io.Closeable.close. Closes this writer and frees any allocated resources.
public Http2FrameWriter.Configuration	configuration() Get the configuration related elements for this `Http2FrameWriter`
public ChannelFuture	Returns: the future for the write. 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) Generic write method for any HTTP/2 frame.
public ChannelFuture	Returns: the future for the write. 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) Writes a GO_AWAY frame to the remote endpoint.
public ChannelFuture	Returns: the future for the write. Section 10.5.1 states the following: The header block MUST be processed to ensure a consistent connection state, unless the connection is closed. If this call has modified the HPACK header state you MUST throw a connection error. If this call has NOT modified the HPACK header state you are free to throw a stream error. 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) Writes a HEADERS frame to the remote endpoint.
public ChannelFuture	Returns: the future for the write. Section 10.5.1 states the following: The header block MUST be processed to ensure a consistent connection state, unless the connection is closed. If this call has modified the HPACK header state you MUST throw a connection error. If this call has NOT modified the HPACK header state you are free to throw a stream error. 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) Writes a HEADERS frame with priority specified to the remote endpoint.
public ChannelFuture	Returns: the future for the write. 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) Writes a PING frame to the remote endpoint.
public ChannelFuture	Returns: the future for the write. 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) Writes a PRIORITY frame to the remote endpoint.
public ChannelFuture	Returns: the future for the write. Section 10.5.1 states the following: The header block MUST be processed to ensure a consistent connection state, unless the connection is closed. If this call has modified the HPACK header state you MUST throw a connection error. If this call has NOT modified the HPACK header state you are free to throw a stream error. 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) Writes a PUSH_PROMISE frame to the remote endpoint.
public ChannelFuture	Returns: the future for the write. 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) Writes a RST_STREAM frame to the remote endpoint.
public ChannelFuture	Returns: the future for the write. writeSettings(ChannelHandlerContext the context to use for writing. ctx, Http2Settings the settings to be sent. settings, ChannelPromise the promise for the write. promise) Writes a SETTINGS frame to the remote endpoint.
public ChannelFuture	Returns: the future for the write. writeSettingsAck(ChannelHandlerContext the context to use for writing. ctx, ChannelPromise the promise for the write. promise) Writes a SETTINGS acknowledgment to the remote endpoint.
public ChannelFuture	Returns: the future for the write. 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) Writes a WINDOW_UPDATE frame to the remote endpoint.

Inherited from io.netty.handler.codec.http2.Http2DataWriter:: writeData

Method Detail

close	back to summary
public void close() Redeclares java.io.Closeable.close. Closes this writer and frees any allocated resources. Annotations @Override

back to summary

public void close()

Redeclares java.io.Closeable.close.

Closes this writer and frees any allocated resources.

Annotations

@Override

configuration	back to summary
public Http2FrameWriter.Configuration configuration() Get the configuration related elements for this `Http2FrameWriter`

writeFrame	back to summary
public ChannelFuture writeFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, ByteBuf payload, ChannelPromise promise) Generic write method for any HTTP/2 frame. This allows writing of non-standard frames. Parameters ctx:ChannelHandlerContext the context to use for writing. frameType:byte the frame type identifier. streamId:int the stream for which to send the frame. flags:Http2Flags the flags to write for this frame. payload:ByteBuf the payload to write for this frame. This will be released by this method. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write.

writeFrame

back to summary

public ChannelFuture writeFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, ByteBuf payload, ChannelPromise promise)

Generic write method for any HTTP/2 frame. This allows writing of non-standard frames.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
frameType:byte: the frame type identifier.
streamId:int: the stream for which to send the frame.
flags:Http2Flags: the flags to write for this frame.
payload:ByteBuf: the payload to write for this frame. This will be released by this method.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write.

writeGoAway	back to summary
public ChannelFuture writeGoAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise) Writes a GO_AWAY frame to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. lastStreamId:int the last known stream of this endpoint. errorCode:long the error code, if the connection was abnormally terminated. debugData:ByteBuf application-defined debug data. This will be released by this method. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write.

writeGoAway

back to summary

public ChannelFuture writeGoAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise)

Writes a GO_AWAY frame to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
lastStreamId:int: the last known stream of this endpoint.
errorCode:long: the error code, if the connection was abnormally terminated.
debugData:ByteBuf: application-defined debug data. This will be released by this method.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write.

writeHeaders	back to summary
public ChannelFuture writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, ChannelPromise promise) Writes a HEADERS frame to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. streamId:int the stream for which to send the frame. headers:Http2Headers the headers to be sent. padding:int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). endStream:boolean indicates if this is the last frame to be sent for the stream. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write. Section 10.5.1 states the following: The header block MUST be processed to ensure a consistent connection state, unless the connection is closed. If this call has modified the HPACK header state you MUST throw a connection error. If this call has NOT modified the HPACK header state you are free to throw a stream error.

writeHeaders

back to summary

public ChannelFuture writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, ChannelPromise promise)

Writes a HEADERS frame to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
streamId:int: the stream for which to send the frame.
headers:Http2Headers: the headers to be sent.
padding:int: additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
endStream:boolean: indicates if this is the last frame to be sent for the stream.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write. Section 10.5.1 states the following:

The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.

If this call has modified the HPACK header state you MUST throw a connection error.

If this call has NOT modified the HPACK header state you are free to throw a stream error.

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) Writes a HEADERS frame with priority specified to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. streamId:int the stream for which to send the frame. headers:Http2Headers the headers to be sent. streamDependency:int the stream on which this stream should depend, or 0 if it should depend on the connection. weight:short the weight for this stream. exclusive:boolean whether this stream should be the exclusive dependant of its parent. padding:int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). endStream:boolean indicates if this is the last frame to be sent for the stream. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write. Section 10.5.1 states the following: The header block MUST be processed to ensure a consistent connection state, unless the connection is closed. If this call has modified the HPACK header state you MUST throw a connection error. If this call has NOT modified the HPACK header state you are free to throw a stream error.

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)

Writes a HEADERS frame with priority specified to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
streamId:int: the stream for which to send the frame.
headers:Http2Headers: the headers to be sent.
streamDependency:int: the stream on which this stream should depend, or 0 if it should depend on the connection.
weight:short: the weight for this stream.
exclusive:boolean: whether this stream should be the exclusive dependant of its parent.
padding:int: additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
endStream:boolean: indicates if this is the last frame to be sent for the stream.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write. Section 10.5.1 states the following:

The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.

If this call has modified the HPACK header state you MUST throw a connection error.

If this call has NOT modified the HPACK header state you are free to throw a stream error.

writePing	back to summary
public ChannelFuture writePing(ChannelHandlerContext ctx, boolean ack, long data, ChannelPromise promise) Writes a PING frame to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. ack:boolean indicates whether this is an ack of a PING frame previously received from the remote endpoint. data:long the payload of the frame. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write.

writePing

back to summary

public ChannelFuture writePing(ChannelHandlerContext ctx, boolean ack, long data, ChannelPromise promise)

Writes a PING frame to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
ack:boolean: indicates whether this is an ack of a PING frame previously received from the remote endpoint.
data:long: the payload of the frame.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write.

writePriority	back to summary
public ChannelFuture writePriority(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive, ChannelPromise promise) Writes a PRIORITY frame to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. streamId:int the stream for which to send the frame. streamDependency:int the stream on which this stream should depend, or 0 if it should depend on the connection. weight:short the weight for this stream. exclusive:boolean whether this stream should be the exclusive dependant of its parent. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write.

writePriority

back to summary

public ChannelFuture writePriority(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive, ChannelPromise promise)

Writes a PRIORITY frame to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
streamId:int: the stream for which to send the frame.
streamDependency:int: the stream on which this stream should depend, or 0 if it should depend on the connection.
weight:short: the weight for this stream.
exclusive:boolean: whether this stream should be the exclusive dependant of its parent.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write.

writePushPromise	back to summary
public ChannelFuture writePushPromise(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding, ChannelPromise promise) Writes a PUSH_PROMISE frame to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. streamId:int the stream for which to send the frame. promisedStreamId:int the ID of the promised stream. headers:Http2Headers the headers to be sent. padding:int additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive). promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write. Section 10.5.1 states the following: The header block MUST be processed to ensure a consistent connection state, unless the connection is closed. If this call has modified the HPACK header state you MUST throw a connection error. If this call has NOT modified the HPACK header state you are free to throw a stream error.

writePushPromise

back to summary

public ChannelFuture writePushPromise(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding, ChannelPromise promise)

Writes a PUSH_PROMISE frame to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
streamId:int: the stream for which to send the frame.
promisedStreamId:int: the ID of the promised stream.
headers:Http2Headers: the headers to be sent.
padding:int: additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write. Section 10.5.1 states the following:

The header block MUST be processed to ensure a consistent connection state, unless the connection is closed.

If this call has modified the HPACK header state you MUST throw a connection error.

If this call has NOT modified the HPACK header state you are free to throw a stream error.

writeRstStream	back to summary
public ChannelFuture writeRstStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise) Writes a RST_STREAM frame to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. streamId:int the stream for which to send the frame. errorCode:long the error code indicating the nature of the failure. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write.

writeRstStream

back to summary

public ChannelFuture writeRstStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise)

Writes a RST_STREAM frame to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
streamId:int: the stream for which to send the frame.
errorCode:long: the error code indicating the nature of the failure.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write.

writeSettings	back to summary
public ChannelFuture writeSettings(ChannelHandlerContext ctx, Http2Settings settings, ChannelPromise promise) Writes a SETTINGS frame to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. settings:Http2Settings the settings to be sent. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write.

writeSettings

back to summary

public ChannelFuture writeSettings(ChannelHandlerContext ctx, Http2Settings settings, ChannelPromise promise)

Writes a SETTINGS frame to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
settings:Http2Settings: the settings to be sent.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write.

writeSettingsAck	back to summary
public ChannelFuture writeSettingsAck(ChannelHandlerContext ctx, ChannelPromise promise) Writes a SETTINGS acknowledgment to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write.

writeSettingsAck

back to summary

public ChannelFuture writeSettingsAck(ChannelHandlerContext ctx, ChannelPromise promise)

Writes a SETTINGS acknowledgment to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write.

writeWindowUpdate	back to summary
public ChannelFuture writeWindowUpdate(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement, ChannelPromise promise) Writes a WINDOW_UPDATE frame to the remote endpoint. Parameters ctx:ChannelHandlerContext the context to use for writing. streamId:int the stream for which to send the frame. windowSizeIncrement:int the number of bytes by which the local inbound flow control window is increasing. promise:ChannelPromise the promise for the write. Returns:ChannelFuture the future for the write.

writeWindowUpdate

back to summary

public ChannelFuture writeWindowUpdate(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement, ChannelPromise promise)

Writes a WINDOW_UPDATE frame to the remote endpoint.

Parameters

ctx:ChannelHandlerContext: the context to use for writing.
streamId:int: the stream for which to send the frame.
windowSizeIncrement:int: the number of bytes by which the local inbound flow control window is increasing.
promise:ChannelPromise: the promise for the write.

Returns:ChannelFuture

the future for the write.

Modifier and Type	Method and Description
public Http2FrameSizePolicy	frameSizePolicy() Get the `Http2FrameSizePolicy` for this `Http2FrameWriter`
public Http2HeadersEncoder.Configuration	headersConfiguration() Get the `Http2HeadersEncoder.Configuration` for this `Http2FrameWriter`

public Interface Http2FrameWriter

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface Http2FrameWriter.Configuration

Method Summary

Method Detail