Module io.netty.codec.http2

Package io.netty5.handler.codec.http2

Class StreamBufferingEncoder

java.lang.Object

io.netty5.handler.codec.http2.DecoratingHttp2FrameWriter

io.netty5.handler.codec.http2.DecoratingHttp2ConnectionEncoder

io.netty5.handler.codec.http2.StreamBufferingEncoder

All Implemented Interfaces:

Http2ConnectionEncoder, Http2DataWriter, Http2FrameWriter, Http2SettingsReceivedConsumer, Closeable, AutoCloseable

@UnstableApi
public class StreamBufferingEncoder
extends DecoratingHttp2ConnectionEncoder

Implementation of a Http2ConnectionEncoder that dispatches all method call to another Http2ConnectionEncoder, until SETTINGS_MAX_CONCURRENT_STREAMS is reached.

When this limit is hit, instead of rejecting any new streams this implementation buffers newly created streams and their corresponding frames. Once an active stream gets closed or the maximum number of concurrent streams is increased, this encoder will automatically try to empty its buffer and create as many new streams as possible.

If a GOAWAY frame is received from the remote endpoint, all buffered writes for streams with an ID less than the specified lastStreamId will immediately fail with a StreamBufferingEncoder.Http2GoAwayException.

If the channel/encoder gets closed, all new and buffered writes will immediately fail with a StreamBufferingEncoder.Http2ChannelClosedException.

This implementation makes the buffering mostly transparent and is expected to be used as a drop-in decorator of DefaultHttp2ConnectionEncoder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamBufferingEncoder.Http2ChannelClosedException	Thrown if buffered streams are terminated due to this encoder being closed.
static class	StreamBufferingEncoder.Http2GoAwayException	Thrown by StreamBufferingEncoder if buffered streams are terminated due to receipt of a GOAWAY.

Nested classes/interfaces inherited from interface io.netty5.handler.codec.http2.Http2FrameWriter

Http2FrameWriter.Configuration

Constructor Summary

Constructors

Constructor	Description
StreamBufferingEncoder(Http2ConnectionEncoder delegate)
StreamBufferingEncoder(Http2ConnectionEncoder delegate, int initialMaxConcurrentStreams)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this writer and frees any allocated resources.
int	numBufferedStreams()	Indicates the number of streams that are currently buffered, awaiting creation.
void	remoteSettings(Http2Settings settings)	Sets the settings for the remote endpoint of the HTTP/2 connection.
Future<Void>	writeData(ChannelHandlerContext ctx, int streamId, Buffer data, int padding, boolean endOfStream)	Writes a DATA 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 endOfStream)	Writes a HEADERS frame with priority specified to the remote endpoint.
Future<Void>	writeRstStream(ChannelHandlerContext ctx, int streamId, long errorCode)	Writes a RST_STREAM frame to the remote endpoint.

Methods inherited from class io.netty5.handler.codec.http2.DecoratingHttp2ConnectionEncoder

connection, consumeReceivedSettings, flowController, frameWriter, lifecycleManager, pollSentSettings

Methods inherited from class io.netty5.handler.codec.http2.DecoratingHttp2FrameWriter

configuration, writeFrame, writeGoAway, writePing, writePriority, writePushPromise, writeSettings, writeSettingsAck, writeWindowUpdate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

writeFrame

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

configuration, writeGoAway, writePing, writePriority, writePushPromise, writeSettings, writeSettingsAck, writeWindowUpdate

Constructor Detail

StreamBufferingEncoder

public StreamBufferingEncoder(Http2ConnectionEncoder delegate)

StreamBufferingEncoder

public StreamBufferingEncoder(Http2ConnectionEncoder delegate,
                              int initialMaxConcurrentStreams)

Method Detail

numBufferedStreams

public int numBufferedStreams()

Indicates the number of streams that are currently buffered, awaiting creation.

writeHeaders

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

Description copied from interface: Http2FrameWriter

Writes a HEADERS frame to the remote endpoint.

Specified by:

writeHeaders in interface Http2FrameWriter

Overrides:

writeHeaders in class DecoratingHttp2FrameWriter

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

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

Description copied from interface: Http2FrameWriter

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

Specified by:

writeHeaders in interface Http2FrameWriter

Overrides:

writeHeaders in class DecoratingHttp2FrameWriter

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).

endOfStream - 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.

writeRstStream

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

Description copied from interface: Http2FrameWriter

Writes a RST_STREAM frame to the remote endpoint.

Specified by:

writeRstStream in interface Http2FrameWriter

Overrides:

writeRstStream in class DecoratingHttp2FrameWriter

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.

writeData

public Future<Void> writeData(ChannelHandlerContext ctx,
                              int streamId,
                              Buffer data,
                              int padding,
                              boolean endOfStream)

Description copied from interface: Http2DataWriter

Writes a DATA frame to the remote endpoint. This will result in one or more frames being written to the context.

Specified by:

writeData in interface Http2DataWriter

Overrides:

writeData in class DecoratingHttp2FrameWriter

Parameters:

ctx - the context to use for writing.

streamId - the stream for which to send the frame.

data - the payload of the frame. This will be released by this method.

padding - 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.

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

Returns:

the future for the write.

remoteSettings

public void remoteSettings(Http2Settings settings)
                    throws Http2Exception

Description copied from interface: Http2ConnectionEncoder

Sets the settings for the remote endpoint of the HTTP/2 connection.

Specified by:

remoteSettings in interface Http2ConnectionEncoder

Overrides:

remoteSettings in class DecoratingHttp2ConnectionEncoder

Throws:

Http2Exception

close

public void close()

Description copied from interface: Http2FrameWriter

Closes this writer and frees any allocated resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Http2FrameWriter

Overrides:

close in class DecoratingHttp2FrameWriter