public class StreamBufferingEncoder extends DecoratingHttp2ConnectionEncoder
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.
| Modifier and Type | Class and 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. |
Http2FrameWriter.Configuration| Constructor and Description |
|---|
StreamBufferingEncoder(Http2ConnectionEncoder delegate) |
StreamBufferingEncoder(Http2ConnectionEncoder delegate,
int initialMaxConcurrentStreams) |
| Modifier and Type | Method and 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.
|
ChannelFuture |
writeData(ChannelHandlerContext ctx,
int streamId,
ByteBuf data,
int padding,
boolean endOfStream,
ChannelPromise promise)
Writes a
DATA frame to the remote endpoint. |
ChannelFuture |
writeHeaders(ChannelHandlerContext ctx,
int streamId,
Http2Headers headers,
int padding,
boolean endStream,
ChannelPromise promise)
Writes a HEADERS frame to the remote endpoint.
|
ChannelFuture |
writeHeaders(ChannelHandlerContext ctx,
int streamId,
Http2Headers headers,
int streamDependency,
short weight,
boolean exclusive,
int padding,
boolean endOfStream,
ChannelPromise promise)
Writes a HEADERS frame with priority specified to the remote endpoint.
|
ChannelFuture |
writeRstStream(ChannelHandlerContext ctx,
int streamId,
long errorCode,
ChannelPromise promise)
Writes a RST_STREAM frame to the remote endpoint.
|
connection, consumeReceivedSettings, flowController, frameWriter, lifecycleManager, pollSentSettingsconfiguration, writeFrame, writeGoAway, writePing, writePriority, writePushPromise, writeSettings, writeSettingsAck, writeWindowUpdateclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitwriteFrameconfiguration, writeGoAway, writePing, writePriority, writePushPromise, writeSettings, writeSettingsAck, writeWindowUpdatepublic StreamBufferingEncoder(Http2ConnectionEncoder delegate)
public StreamBufferingEncoder(Http2ConnectionEncoder delegate, int initialMaxConcurrentStreams)
public int numBufferedStreams()
public ChannelFuture writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endStream, ChannelPromise promise)
Http2FrameWriterwriteHeaders in interface Http2FrameWriterwriteHeaders in class DecoratingHttp2FrameWriterctx - 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.promise - the promise for the write.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.
public ChannelFuture writeHeaders(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endOfStream, ChannelPromise promise)
Http2FrameWriterwriteHeaders in interface Http2FrameWriterwriteHeaders in class DecoratingHttp2FrameWriterctx - 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.promise - the promise for the write.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.
public ChannelFuture writeRstStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise)
Http2FrameWriterwriteRstStream in interface Http2FrameWriterwriteRstStream in class DecoratingHttp2FrameWriterctx - 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.promise - the promise for the write.public ChannelFuture writeData(ChannelHandlerContext ctx, int streamId, ByteBuf data, int padding, boolean endOfStream, ChannelPromise promise)
Http2DataWriterDATA frame to the remote endpoint. This will result in one or more
frames being written to the context.writeData in interface Http2DataWriterwriteData in class DecoratingHttp2FrameWriterctx - 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.promise - the promise for the write.public void remoteSettings(Http2Settings settings) throws Http2Exception
Http2ConnectionEncoderremoteSettings in interface Http2ConnectionEncoderremoteSettings in class DecoratingHttp2ConnectionEncoderHttp2Exceptionpublic void close()
Http2FrameWriterclose in interface Http2FrameWriterclose in interface Closeableclose in interface AutoCloseableclose in class DecoratingHttp2FrameWriterCopyright © 2008–2024 The Netty Project. All rights reserved.