Nested and Inner Type Summary

Modifier and Type	Class and Description
protected class	DefaultHttp2FrameReader.HeadersBlockBuilder Utility class to help with construction of the headers block that may potentially span multiple frames.
private abstract class	DefaultHttp2FrameReader.HeadersContinuation Base class for processing of HEADERS and PUSH_PROMISE header blocks that potentially span multiple frames.

Field Summary

Modifier and Type	Field and Description
private Http2Flags	flags
private byte	frameType
private DefaultHttp2FrameReader.HeadersContinuation	headersContinuation
private final Http2HeadersDecoder	headersDecoder
private int	maxFrameSize
private int	payloadLength
private boolean	readError Once set to `true` the value will never change.
private boolean	readingHeaders `true` = reading headers, `false` = reading payload.
private int	streamId

Constructor Summary

Access	Constructor and Description
public	DefaultHttp2FrameReader() Create a new instance.
public	DefaultHttp2FrameReader(boolean `true` to validate headers. `false` to not validate headers. validateHeaders) Create a new instance.
public	DefaultHttp2FrameReader(Http2HeadersDecoder headersDecoder)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements io.netty.handler.codec.http2.Http2FrameReader.close. Closes this reader and frees any allocated resources.
private void	closeHeadersContinuation()
public Http2FrameReader.Configuration	configuration() Implements io.netty.handler.codec.http2.Http2FrameReader.configuration. Get the configuration related elements for this `Http2FrameReader`
public Http2FrameSizePolicy	frameSizePolicy() Implements io.netty.handler.codec.http2.Http2FrameReader.Configuration.frameSizePolicy. Get the `Http2FrameSizePolicy` for this `Http2FrameReader`
public Http2HeadersDecoder.Configuration	headersConfiguration() Implements io.netty.handler.codec.http2.Http2FrameReader.Configuration.headersConfiguration. Get the `Http2HeadersDecoder.Configuration` for this `Http2FrameReader`
private static int	lengthWithoutTrailingPadding(int readableBytes, int padding) The padding parameter consists of the 1 byte pad length field and the trailing padding bytes.
public void	maxFrameSize(int max) Implements io.netty.handler.codec.http2.Http2FrameSizePolicy.maxFrameSize. Sets the maximum allowed frame size.
public int	maxFrameSize() Implements io.netty.handler.codec.http2.Http2FrameSizePolicy.maxFrameSize. Gets the maximum allowed frame size.
private void	processHeaderState(ByteBuf in)
private void	processPayloadState(ChannelHandlerContext ctx, ByteBuf in, Http2FrameListener listener)
private void	readContinuationFrame(ByteBuf payload, int payloadEndIndex, Http2FrameListener listener)
private void	readDataFrame(ChannelHandlerContext ctx, ByteBuf payload, int payloadEndIndex, Http2FrameListener listener)
public void	readFrame(ChannelHandlerContext ctx, ByteBuf input, Http2FrameListener listener) Implements io.netty.handler.codec.http2.Http2FrameReader.readFrame. Attempts to read the next frame from the input buffer.
private static void	readGoAwayFrame(ChannelHandlerContext ctx, ByteBuf payload, int payloadEndIndex, Http2FrameListener listener)
private void	readHeadersFrame(final ChannelHandlerContext ctx, ByteBuf payload, int payloadEndIndex, Http2FrameListener listener)
private int	readPadding(ByteBuf payload) If padding is present in the payload, reads the next byte as padding.
private void	readPingFrame(ChannelHandlerContext ctx, long data, Http2FrameListener listener)
private void	readPriorityFrame(ChannelHandlerContext ctx, ByteBuf payload, Http2FrameListener listener)
private void	readPushPromiseFrame(final ChannelHandlerContext ctx, ByteBuf payload, int payloadEndIndex, Http2FrameListener listener)
private void	readRstStreamFrame(ChannelHandlerContext ctx, ByteBuf payload, Http2FrameListener listener)
private void	readSettingsFrame(ChannelHandlerContext ctx, ByteBuf payload, Http2FrameListener listener)
private void	readUnknownFrame(ChannelHandlerContext ctx, ByteBuf payload, int payloadEndIndex, Http2FrameListener listener)
private void	readWindowUpdateFrame(ChannelHandlerContext ctx, ByteBuf payload, Http2FrameListener listener)
private void	resetHeadersContinuationIfEnd(boolean endOfHeaders)
private void	verifyAssociatedWithAStream()
private void	verifyContinuationFrame()
private void	verifyDataFrame()
private void	verifyGoAwayFrame()
private void	verifyHeadersFrame()
private void	verifyNotProcessingHeaders() Verify that current state is not processing on header block
private void	verifyPadding(int padding)
private void	verifyPingFrame()
private void	verifyPriorityFrame()
private void	verifyPushPromiseFrame()
private void	verifyRstStreamFrame()
private void	verifySettingsFrame()
private static void	verifyStreamOrConnectionId(int streamId, String argumentName)
private void	verifyUnknownFrame()
private void	verifyWindowUpdateFrame()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

flags	back to summary
private Http2Flags flags

frameType	back to summary
private byte frameType

headersContinuation	back to summary
private DefaultHttp2FrameReader.HeadersContinuation headersContinuation

headersDecoder	back to summary
private final Http2HeadersDecoder headersDecoder

maxFrameSize	back to summary
private int maxFrameSize

payloadLength	back to summary
private int payloadLength

readError	back to summary
private boolean readError Once set to `true` the value will never change. This is set to `true` if an unrecoverable error which renders the connection unusable.

readingHeaders	back to summary
private boolean readingHeaders `true` = reading headers, `false` = reading payload.

streamId	back to summary
private int streamId

Constructor Detail

DefaultHttp2FrameReader	back to summary
public DefaultHttp2FrameReader() Create a new instance. Header names will be validated.

DefaultHttp2FrameReader

back to summary

public DefaultHttp2FrameReader()

Create a new instance.

Header names will be validated.

DefaultHttp2FrameReader back to summary

DefaultHttp2FrameReader	back to summary
public DefaultHttp2FrameReader(boolean validateHeaders) Create a new instance. Parameters validateHeaders:boolean `true` to validate headers. `false` to not validate headers. See Also `DefaultHttp2HeadersDecoder(boolean)`

public DefaultHttp2FrameReader(boolean validateHeaders)

Create a new instance.

Parameters

validateHeaders:boolean: true to validate headers. false to not validate headers.

See Also

DefaultHttp2HeadersDecoder(boolean)

DefaultHttp2FrameReader	back to summary
public DefaultHttp2FrameReader(Http2HeadersDecoder headersDecoder)

Method Detail

close	back to summary
public void close() Implements io.netty.handler.codec.http2.Http2FrameReader.close. Doc from io.netty.handler.codec.http2.Http2FrameReader.close. Closes this reader and frees any allocated resources. Annotations @Override

back to summary

public void close()

Implements io.netty.handler.codec.http2.Http2FrameReader.close.

Doc from io.netty.handler.codec.http2.Http2FrameReader.close.

Closes this reader and frees any allocated resources.

Annotations

@Override

closeHeadersContinuation	back to summary
private void closeHeadersContinuation()

configuration back to summary

configuration	back to summary
public Http2FrameReader.Configuration configuration() Implements io.netty.handler.codec.http2.Http2FrameReader.configuration. Doc from io.netty.handler.codec.http2.Http2FrameReader.configuration. Get the configuration related elements for this `Http2FrameReader` Annotations @Override

public Http2FrameReader.Configuration configuration()

Implements io.netty.handler.codec.http2.Http2FrameReader.configuration.

Doc from io.netty.handler.codec.http2.Http2FrameReader.configuration.

Get the configuration related elements for this Http2FrameReader

Annotations

@Override

frameSizePolicy back to summary

frameSizePolicy	back to summary
public Http2FrameSizePolicy frameSizePolicy() Implements io.netty.handler.codec.http2.Http2FrameReader.Configuration.frameSizePolicy. Doc from io.netty.handler.codec.http2.Http2FrameReader.Configuration.frameSizePolicy. Get the `Http2FrameSizePolicy` for this `Http2FrameReader` Annotations @Override

public Http2FrameSizePolicy frameSizePolicy()

Implements io.netty.handler.codec.http2.Http2FrameReader.Configuration.frameSizePolicy.

Doc from io.netty.handler.codec.http2.Http2FrameReader.Configuration.frameSizePolicy.

Get the Http2FrameSizePolicy for this Http2FrameReader

Annotations

@Override

headersConfiguration back to summary

headersConfiguration	back to summary
public Http2HeadersDecoder.Configuration headersConfiguration() Implements io.netty.handler.codec.http2.Http2FrameReader.Configuration.headersConfiguration. Doc from io.netty.handler.codec.http2.Http2FrameReader.Configuration.headersConfiguration. Get the `Http2HeadersDecoder.Configuration` for this `Http2FrameReader` Annotations @Override

public Http2HeadersDecoder.Configuration headersConfiguration()

Implements io.netty.handler.codec.http2.Http2FrameReader.Configuration.headersConfiguration.

Doc from io.netty.handler.codec.http2.Http2FrameReader.Configuration.headersConfiguration.

Get the Http2HeadersDecoder.Configuration for this Http2FrameReader

Annotations

@Override

lengthWithoutTrailingPadding	back to summary
private static int lengthWithoutTrailingPadding(int readableBytes, int padding) The padding parameter consists of the 1 byte pad length field and the trailing padding bytes. This method returns the number of readable bytes without the trailing padding.

maxFrameSize back to summary

maxFrameSize	back to summary
public void maxFrameSize(int max) throws Http2Exception Implements io.netty.handler.codec.http2.Http2FrameSizePolicy.maxFrameSize. Doc from io.netty.handler.codec.http2.Http2FrameSizePolicy.maxFrameSize. Sets the maximum allowed frame size. Attempts to write frames longer than this maximum will fail. This value is used to represent SETTINGS_MAX_FRAME_SIZE. This method should only be called by Netty (not users) as a result of a receiving a `SETTINGS` frame. Annotations @Override

public void maxFrameSize(int max) throws Http2Exception

Implements io.netty.handler.codec.http2.Http2FrameSizePolicy.maxFrameSize.

Doc from io.netty.handler.codec.http2.Http2FrameSizePolicy.maxFrameSize.

Sets the maximum allowed frame size. Attempts to write frames longer than this maximum will fail.

This value is used to represent SETTINGS_MAX_FRAME_SIZE. This method should only be called by Netty (not users) as a result of a receiving a SETTINGS frame.

Annotations

@Override

maxFrameSize back to summary

maxFrameSize	back to summary
public int maxFrameSize() Implements io.netty.handler.codec.http2.Http2FrameSizePolicy.maxFrameSize. Doc from io.netty.handler.codec.http2.Http2FrameSizePolicy.maxFrameSize. Gets the maximum allowed frame size. This value is used to represent SETTINGS_MAX_FRAME_SIZE. The initial value defined by the RFC is unlimited but enforcing a lower limit is generally permitted. `Http2CodecUtil#DEFAULT_MAX_FRAME_SIZE` can be used as a more conservative default. Annotations @Override

public int maxFrameSize()

Implements io.netty.handler.codec.http2.Http2FrameSizePolicy.maxFrameSize.

Doc from io.netty.handler.codec.http2.Http2FrameSizePolicy.maxFrameSize.

Gets the maximum allowed frame size.

This value is used to represent SETTINGS_MAX_FRAME_SIZE. The initial value defined by the RFC is unlimited but enforcing a lower limit is generally permitted. Http2CodecUtil#DEFAULT_MAX_FRAME_SIZE can be used as a more conservative default.

Annotations

@Override

processHeaderState	back to summary
private void processHeaderState(ByteBuf in) throws Http2Exception

processPayloadState	back to summary
private void processPayloadState(ChannelHandlerContext ctx, ByteBuf in, Http2FrameListener listener) throws Http2Exception

readContinuationFrame	back to summary
private void readContinuationFrame(ByteBuf payload, int payloadEndIndex, Http2FrameListener listener) throws Http2Exception

readDataFrame	back to summary
private void readDataFrame(ChannelHandlerContext ctx, ByteBuf payload, int payloadEndIndex, Http2FrameListener listener) throws Http2Exception

readFrame	back to summary
public void readFrame(ChannelHandlerContext ctx, ByteBuf input, Http2FrameListener listener) throws Http2Exception Implements io.netty.handler.codec.http2.Http2FrameReader.readFrame. Doc from io.netty.handler.codec.http2.Http2FrameReader.readFrame. Attempts to read the next frame from the input buffer. If enough data is available to fully read the frame, notifies the listener of the read frame. Annotations @Override

readFrame

back to summary

public void readFrame(ChannelHandlerContext ctx, ByteBuf input, Http2FrameListener listener) throws Http2Exception

Implements io.netty.handler.codec.http2.Http2FrameReader.readFrame.

Doc from io.netty.handler.codec.http2.Http2FrameReader.readFrame.

Attempts to read the next frame from the input buffer. If enough data is available to fully read the frame, notifies the listener of the read frame.

Annotations

@Override

readGoAwayFrame	back to summary
private static void readGoAwayFrame(ChannelHandlerContext ctx, ByteBuf payload, int payloadEndIndex, Http2FrameListener listener) throws Http2Exception

readHeadersFrame	back to summary
private void readHeadersFrame(final ChannelHandlerContext ctx, ByteBuf payload, int payloadEndIndex, Http2FrameListener listener) throws Http2Exception

readPadding	back to summary
private int readPadding(ByteBuf payload) If padding is present in the payload, reads the next byte as padding. The padding also includes the one byte width of the pad length field. Otherwise, returns zero.

readPingFrame	back to summary
private void readPingFrame(ChannelHandlerContext ctx, long data, Http2FrameListener listener) throws Http2Exception

readPriorityFrame	back to summary
private void readPriorityFrame(ChannelHandlerContext ctx, ByteBuf payload, Http2FrameListener listener) throws Http2Exception

readPushPromiseFrame	back to summary
private void readPushPromiseFrame(final ChannelHandlerContext ctx, ByteBuf payload, int payloadEndIndex, Http2FrameListener listener) throws Http2Exception

readRstStreamFrame	back to summary
private void readRstStreamFrame(ChannelHandlerContext ctx, ByteBuf payload, Http2FrameListener listener) throws Http2Exception

readSettingsFrame	back to summary
private void readSettingsFrame(ChannelHandlerContext ctx, ByteBuf payload, Http2FrameListener listener) throws Http2Exception

readUnknownFrame	back to summary
private void readUnknownFrame(ChannelHandlerContext ctx, ByteBuf payload, int payloadEndIndex, Http2FrameListener listener) throws Http2Exception

readWindowUpdateFrame	back to summary
private void readWindowUpdateFrame(ChannelHandlerContext ctx, ByteBuf payload, Http2FrameListener listener) throws Http2Exception

resetHeadersContinuationIfEnd	back to summary
private void resetHeadersContinuationIfEnd(boolean endOfHeaders)

verifyAssociatedWithAStream	back to summary
private void verifyAssociatedWithAStream() throws Http2Exception

verifyContinuationFrame	back to summary
private void verifyContinuationFrame() throws Http2Exception

verifyDataFrame	back to summary
private void verifyDataFrame() throws Http2Exception

verifyGoAwayFrame	back to summary
private void verifyGoAwayFrame() throws Http2Exception

verifyHeadersFrame	back to summary
private void verifyHeadersFrame() throws Http2Exception

verifyNotProcessingHeaders back to summary

verifyNotProcessingHeaders	back to summary
private void verifyNotProcessingHeaders() throws Http2Exception Verify that current state is not processing on header block Exceptions Http2Exception: thrown if `headersContinuation` is not null

private void verifyNotProcessingHeaders() throws Http2Exception

Verify that current state is not processing on header block

Exceptions

Http2Exception:: thrown if headersContinuation is not null

verifyPadding	back to summary
private void verifyPadding(int padding) throws Http2Exception

verifyPingFrame	back to summary
private void verifyPingFrame() throws Http2Exception

verifyPriorityFrame	back to summary
private void verifyPriorityFrame() throws Http2Exception

verifyPushPromiseFrame	back to summary
private void verifyPushPromiseFrame() throws Http2Exception

verifyRstStreamFrame	back to summary
private void verifyRstStreamFrame() throws Http2Exception

verifySettingsFrame	back to summary
private void verifySettingsFrame() throws Http2Exception

verifyStreamOrConnectionId	back to summary
private static void verifyStreamOrConnectionId(int streamId, String argumentName) throws Http2Exception

verifyUnknownFrame	back to summary
private void verifyUnknownFrame() throws Http2Exception

verifyWindowUpdateFrame	back to summary
private void verifyWindowUpdateFrame() throws Http2Exception

Field Summary

Modifier and Type	Field and Description
private ByteBuf	headerBlock

Method Summary

Modifier and Type	Method and Description
pack-priv final void	addFragment(ByteBuf the fragment of the headers block to be added. fragment, int len, ByteBufAllocator allocator for new blocks if needed. alloc, boolean flag indicating whether the current frame is the end of the headers. This is used for an optimization for when the first fragment is the full block. In that case, the buffer is used directly without copying. endOfHeaders) Adds a fragment to the block.
pack-priv void	close() Closes this builder and frees any resources.
pack-priv Http2Headers	headers() Builds the headers from the completed headers block.
private void	headerSizeExceeded() The local header size maximum has been exceeded while accumulating bytes.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

headerBlock	back to summary
private ByteBuf headerBlock

Constructor Detail

HeadersBlockBuilder	back to summary
protected HeadersBlockBuilder()

Method Detail

addFragment

back to summary

pack-priv final void addFragment(ByteBuf fragment, int len, ByteBufAllocator alloc, boolean endOfHeaders) throws Http2Exception

Adds a fragment to the block.

Parameters

fragment:ByteBuf: the fragment of the headers block to be added.
alloc:ByteBufAllocator: allocator for new blocks if needed.
endOfHeaders:boolean: flag indicating whether the current frame is the end of the headers. This is used for an optimization for when the first fragment is the full block. In that case, the buffer is used directly without copying.

close	back to summary
pack-priv void close() Closes this builder and frees any resources.

headers	back to summary
pack-priv Http2Headers headers() throws Http2Exception Builds the headers from the completed headers block. After this is called, this builder should not be called again.

headerSizeExceeded

back to summary

private void headerSizeExceeded() throws Http2Exception

The local header size maximum has been exceeded while accumulating bytes.

Exceptions

Http2Exception:: A connection error indicating too much data has been received.

io.netty.handler.codec.http2 back to summary

private abstract Class DefaultHttp2FrameReader.HeadersContinuation

Class Inheritance

extends Object

java.lang.Object
io.netty.handler.codec.http2.DefaultHttp2FrameReader.HeadersContinuation

Base class for processing of HEADERS and PUSH_PROMISE header blocks that potentially span multiple frames. The implementation of this interface will perform the final callback to the Http2FrameListener once the end of headers is reached.

Field Summary

Modifier and Type	Field and Description
private final DefaultHttp2FrameReader.HeadersBlockBuilder	builder

Constructor Summary

Access	Constructor and Description
private	HeadersContinuation()

Method Summary

Modifier and Type	Method and Description
pack-priv final void	close() Free any allocated resources.
pack-priv abstract int	getStreamId() Returns the stream for which headers are currently being processed.
pack-priv final DefaultHttp2FrameReader.HeadersBlockBuilder	headersBlockBuilder()
pack-priv abstract void	processFragment(boolean whether the fragment is the last in the header block. endOfHeaders, ByteBuf the fragment of the header block to be added. fragment, int len, Http2FrameListener the listener to be notified if the header block is completed. listener) Processes the next fragment for the current header block.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

builder	back to summary
private final DefaultHttp2FrameReader.HeadersBlockBuilder builder

Constructor Detail

HeadersContinuation	back to summary
private HeadersContinuation()

Method Detail

close	back to summary
pack-priv final void close() Free any allocated resources.

getStreamId	back to summary
pack-priv abstract int getStreamId() Returns the stream for which headers are currently being processed.

headersBlockBuilder	back to summary
pack-priv final DefaultHttp2FrameReader.HeadersBlockBuilder headersBlockBuilder()

processFragment

back to summary

pack-priv abstract void processFragment(boolean endOfHeaders, ByteBuf fragment, int len, Http2FrameListener listener) throws Http2Exception

Processes the next fragment for the current header block.

Parameters

endOfHeaders:boolean: whether the fragment is the last in the header block.
fragment:ByteBuf: the fragment of the header block to be added.
listener:Http2FrameListener: the listener to be notified if the header block is completed.

public Class DefaultHttp2FrameReader

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class DefaultHttp2FrameReader.HeadersBlockBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private abstract Class DefaultHttp2FrameReader.HeadersContinuation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail