Module io.netty.codec.http2

Package io.netty5.handler.codec.http2

Interface Http2FrameWriter

All Superinterfaces:

AutoCloseable, Closeable, Http2DataWriter

All Known Subinterfaces:

Http2ConnectionEncoder

All Known Implementing Classes:

CompressorHttp2ConnectionEncoder, DecoratingHttp2ConnectionEncoder, DecoratingHttp2FrameWriter, DefaultHttp2ConnectionEncoder, DefaultHttp2FrameWriter, Http2OutboundFrameLogger, StreamBufferingEncoder

@UnstableApi
public interface Http2FrameWriter
extends Http2DataWriter, Closeable

A writer responsible for marshaling HTTP/2 frames to the channel. All of the write methods in this interface write to the context, but DO NOT FLUSH. To perform a flush, you must separately call ChannelHandlerContext.flush().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Http2FrameWriter.Configuration	Configuration specific to Http2FrameWriter

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this writer and frees any allocated resources.
Http2FrameWriter.Configuration	configuration()	Get the configuration related elements for this Http2FrameWriter
Future<Void>	writeFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, Buffer payload)	Generic write method for any HTTP/2 frame.
Future<Void>	writeGoAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, Buffer debugData)	Writes a GO_AWAY frame to the remote endpoint.
Future<Void>	writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream)	Writes a HEADERS frame to the remote endpoint.
Future<Void>	writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endStream)	Writes a HEADERS frame with priority specified to the remote endpoint.
Future<Void>	writePing(ChannelHandlerContext ctx, boolean ack, long data)	Writes a PING frame to the remote endpoint.
Future<Void>	writePriority(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive)	Writes a PRIORITY frame to the remote endpoint.
Future<Void>	writePushPromise(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding)	Writes a PUSH_PROMISE frame to the remote endpoint.
Future<Void>	writeRstStream(ChannelHandlerContext ctx, int streamId, long errorCode)	Writes a RST_STREAM frame to the remote endpoint.
Future<Void>	writeSettings(ChannelHandlerContext ctx, Http2Settings settings)	Writes a SETTINGS frame to the remote endpoint.
Future<Void>	writeSettingsAck(ChannelHandlerContext ctx)	Writes a SETTINGS acknowledgment to the remote endpoint.
Future<Void>	writeWindowUpdate(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement)	Writes a WINDOW_UPDATE frame to the remote endpoint.

Methods inherited from interface io.netty5.handler.codec.http2.Http2DataWriter

writeData

Method Detail

writeHeaders

Future<Void> writeHeaders(ChannelHandlerContext ctx,
                          int streamId,
                          Http2Headers headers,
                          int padding,
                          boolean endStream)

Writes a HEADERS frame to the remote endpoint.

Parameters:

ctx - the context to use for writing.

streamId - the stream for which to send the frame.

headers - the headers to be sent.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

endStream - indicates if this is the last frame to be sent for the stream.

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

Future<Void> writeHeaders(ChannelHandlerContext ctx,
                          int streamId,
                          Http2Headers headers,
                          int streamDependency,
                          short weight,
                          boolean exclusive,
                          int padding,
                          boolean endStream)

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

Parameters:

ctx - the context to use for writing.

streamId - the stream for which to send the frame.

headers - the headers to be sent.

streamDependency - the stream on which this stream should depend, or 0 if it should depend on the connection.

weight - the weight for this stream.

exclusive - whether this stream should be the exclusive dependant of its parent.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

endStream - indicates if this is the last frame to be sent for the stream.

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.

writePriority

Future<Void> writePriority(ChannelHandlerContext ctx,
                           int streamId,
                           int streamDependency,
                           short weight,
                           boolean exclusive)

Writes a PRIORITY frame to the remote endpoint.

Parameters:

ctx - the context to use for writing.

streamId - the stream for which to send the frame.

streamDependency - the stream on which this stream should depend, or 0 if it should depend on the connection.

weight - the weight for this stream.

exclusive - whether this stream should be the exclusive dependant of its parent.

Returns:

the future for the write.

writeRstStream

Future<Void> writeRstStream(ChannelHandlerContext ctx,
                            int streamId,
                            long errorCode)

Writes a RST_STREAM frame to the remote endpoint.

Parameters:

ctx - the context to use for writing.

streamId - the stream for which to send the frame.

errorCode - the error code indicating the nature of the failure.

Returns:

the future for the write.

writeSettings

Future<Void> writeSettings(ChannelHandlerContext ctx,
                           Http2Settings settings)

Writes a SETTINGS frame to the remote endpoint.

Parameters:

ctx - the context to use for writing.

settings - the settings to be sent.

Returns:

the future for the write.

writeSettingsAck

Future<Void> writeSettingsAck(ChannelHandlerContext ctx)

Writes a SETTINGS acknowledgment to the remote endpoint.

Parameters:

ctx - the context to use for writing.

Returns:

the future for the write.

writePing

Future<Void> writePing(ChannelHandlerContext ctx,
                       boolean ack,
                       long data)

Writes a PING frame to the remote endpoint.

Parameters:

ctx - the context to use for writing.

ack - indicates whether this is an ack of a PING frame previously received from the remote endpoint.

data - the payload of the frame.

Returns:

the future for the write.

writePushPromise

Future<Void> writePushPromise(ChannelHandlerContext ctx,
                              int streamId,
                              int promisedStreamId,
                              Http2Headers headers,
                              int padding)

Writes a PUSH_PROMISE frame to the remote endpoint.

Parameters:

ctx - the context to use for writing.

streamId - the stream for which to send the frame.

promisedStreamId - the ID of the promised stream.

headers - the headers to be sent.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

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.

writeGoAway

Future<Void> writeGoAway(ChannelHandlerContext ctx,
                         int lastStreamId,
                         long errorCode,
                         Buffer debugData)

Writes a GO_AWAY frame to the remote endpoint.

Parameters:

ctx - the context to use for writing.

lastStreamId - the last known stream of this endpoint.

errorCode - the error code, if the connection was abnormally terminated.

debugData - application-defined debug data. This will be released by this method.

Returns:

the future for the write.

writeWindowUpdate

Future<Void> writeWindowUpdate(ChannelHandlerContext ctx,
                               int streamId,
                               int windowSizeIncrement)

Writes a WINDOW_UPDATE frame to the remote endpoint.

Parameters:

ctx - the context to use for writing.

streamId - the stream for which to send the frame.

windowSizeIncrement - the number of bytes by which the local inbound flow control window is increasing.

Returns:

the future for the write.

writeFrame

Future<Void> writeFrame(ChannelHandlerContext ctx,
                        byte frameType,
                        int streamId,
                        Http2Flags flags,
                        Buffer payload)

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

Parameters:

ctx - the context to use for writing.

frameType - the frame type identifier.

streamId - the stream for which to send the frame.

flags - the flags to write for this frame.

payload - the payload to write for this frame. This will be released by this method.

Returns:

the future for the write.

configuration

Http2FrameWriter.Configuration configuration()

Get the configuration related elements for this Http2FrameWriter

close

void close()

Closes this writer and frees any allocated resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable