io.netty.handler.codec.http2

Class Http2ConnectionHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.http2.Http2ConnectionHandler

All Implemented Interfaces:

ChannelHandler, Http2LifecycleManager

Direct Known Subclasses:

HttpToHttp2ConnectionHandler

public class Http2ConnectionHandler
extends ByteToMessageDecoder
implements Http2LifecycleManager

Provides the default implementation for processing inbound frame events and delegates to a Http2FrameListener

This class will read HTTP/2 frames and delegate the events to a Http2FrameListener

This interface enforces inbound flow control functionality through Http2LocalFlowController

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable, ChannelHandler.Skip

Field Summary

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor and Description
Http2ConnectionHandler(boolean server, Http2FrameListener listener)
Http2ConnectionHandler(Http2ConnectionDecoder.Builder decoderBuilder, Http2ConnectionEncoder.Builder encoderBuilder) Constructor for pre-configured encoder and decoder builders.
Http2ConnectionHandler(Http2Connection connection, Http2FrameListener listener)
Http2ConnectionHandler(Http2Connection connection, Http2FrameReader frameReader, Http2FrameWriter frameWriter, Http2FrameListener listener)

Method Summary

Methods

Modifier and Type	Method and Description
void	channelActive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelHandler in the ChannelPipeline.
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise) Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline.
void	closeLocalSide(Http2Stream stream, ChannelFuture future) Closes the local side of the given stream.
void	closeRemoteSide(Http2Stream stream, ChannelFuture future) Closes the remote side of the given stream.
void	closeStream(Http2Stream stream, ChannelFuture future) Closes the given stream and adds a hook to close the channel after the given future completes.
Http2Connection	connection()
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) Decode the from one ByteBuf to an other.
Http2ConnectionDecoder	decoder()
Http2ConnectionEncoder	encoder()
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Handles Http2Exception objects that were thrown from other handlers.
protected Http2FrameWriter	frameWriter()
void	handlerAdded(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.
protected void	handlerRemoved0(ChannelHandlerContext ctx) Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.
protected void	onConnectionError(ChannelHandlerContext ctx, Throwable cause, Http2Exception http2Ex) Handler for a connection error.
void	onException(ChannelHandlerContext ctx, Throwable cause) Central handler for all exceptions caught during HTTP/2 processing.
void	onHttpClientUpgrade() Handles the client-side (cleartext) upgrade from HTTP to HTTP/2.
void	onHttpServerUpgrade(Http2Settings settings) Handles the server-side (cleartext) upgrade from HTTP to HTTP/2.
protected void	onStreamError(ChannelHandlerContext ctx, Throwable cause, Http2Exception.StreamException http2Ex) Handler for a stream error.
ChannelFuture	writeGoAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise) Sends a GO_AWAY frame to the remote endpoint and updates the connection state appropriately.
ChannelFuture	writeRstStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise) Writes a RST_STREAM frame to the remote endpoint and updates the connection state appropriately.

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder

actualReadableBytes, callDecode, channelRead, channelReadComplete, decodeLast, handlerRemoved, internalBuffer, isSingleDecode, setCumulator, setSingleDecode

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelRegistered, channelUnregistered, channelWritabilityChanged, connect, deregister, disconnect, flush, isSharable, read, userEventTriggered, write

Methods inherited from class java.lang.Object

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

Constructor Detail

Http2ConnectionHandler

public Http2ConnectionHandler(boolean server,
                      Http2FrameListener listener)

Http2ConnectionHandler

public Http2ConnectionHandler(Http2Connection connection,
                      Http2FrameListener listener)

Http2ConnectionHandler

public Http2ConnectionHandler(Http2Connection connection,
                      Http2FrameReader frameReader,
                      Http2FrameWriter frameWriter,
                      Http2FrameListener listener)

Http2ConnectionHandler

public Http2ConnectionHandler(Http2ConnectionDecoder.Builder decoderBuilder,
                      Http2ConnectionEncoder.Builder encoderBuilder)

Constructor for pre-configured encoder and decoder builders. Just sets the this as the Http2LifecycleManager and builds them.

Method Detail

connection

public Http2Connection connection()

decoder

public Http2ConnectionDecoder decoder()

encoder

public Http2ConnectionEncoder encoder()

onHttpClientUpgrade

public void onHttpClientUpgrade()
                         throws Http2Exception

Handles the client-side (cleartext) upgrade from HTTP to HTTP/2. Reserves local stream 1 for the HTTP/2 response.

Throws:

Http2Exception

onHttpServerUpgrade

public void onHttpServerUpgrade(Http2Settings settings)
                         throws Http2Exception

Handles the server-side (cleartext) upgrade from HTTP to HTTP/2.

Parameters:

settings - the settings for the remote endpoint.

Throws:

Http2Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelActive in interface ChannelHandler

Overrides:

channelActive in class ChannelHandlerAdapter

Throws:

Exception

handlerAdded

public void handlerAdded(ChannelHandlerContext ctx)
                  throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerAdded in interface ChannelHandler

Overrides:

handlerAdded in class ChannelHandlerAdapter

Throws:

Exception

handlerRemoved0

protected void handlerRemoved0(ChannelHandlerContext ctx)
                        throws Exception

Description copied from class: ByteToMessageDecoder

Gets called after the ByteToMessageDecoder was removed from the actual context and it doesn't handle events anymore.

Overrides:

handlerRemoved0 in class ByteToMessageDecoder

Throws:

Exception

close

public void close(ChannelHandlerContext ctx,
         ChannelPromise promise)
           throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.close(ChannelPromise) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

close in interface ChannelHandler

Overrides:

close in class ChannelHandlerAdapter

Parameters:

ctx - the ChannelHandlerContext for which the close operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error accour

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Description copied from class: ChannelHandlerAdapter

Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelInactive in interface ChannelHandler

Overrides:

channelInactive in class ByteToMessageDecoder

Throws:

Exception

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
                   Throwable cause)
                     throws Exception

Handles Http2Exception objects that were thrown from other handlers. Ignores all other exceptions.

Specified by:

exceptionCaught in interface ChannelHandler

Overrides:

exceptionCaught in class ChannelHandlerAdapter

Throws:

Exception

closeLocalSide

public void closeLocalSide(Http2Stream stream,
                  ChannelFuture future)

Closes the local side of the given stream. If this causes the stream to be closed, adds a hook to close the channel after the given future completes.

Specified by:

closeLocalSide in interface Http2LifecycleManager

Parameters:

stream - the stream to be half closed.

future - If closing, the future after which to close the channel.

closeRemoteSide

public void closeRemoteSide(Http2Stream stream,
                   ChannelFuture future)

Closes the remote side of the given stream. If this causes the stream to be closed, adds a hook to close the channel after the given future completes.

Specified by:

closeRemoteSide in interface Http2LifecycleManager

Parameters:

stream - the stream to be half closed.

future - If closing, the future after which to close the channel.

closeStream

public void closeStream(Http2Stream stream,
               ChannelFuture future)

Closes the given stream and adds a hook to close the channel after the given future completes.

Specified by:

closeStream in interface Http2LifecycleManager

Parameters:

stream - the stream to be closed.

future - the future after which to close the channel.

onException

public void onException(ChannelHandlerContext ctx,
               Throwable cause)

Central handler for all exceptions caught during HTTP/2 processing.

Specified by:

onException in interface Http2LifecycleManager

onConnectionError

protected void onConnectionError(ChannelHandlerContext ctx,
                     Throwable cause,
                     Http2Exception http2Ex)

Handler for a connection error. Sends a GO_AWAY frame to the remote endpoint. Once all streams are closed, the connection is shut down.

Parameters:

ctx - the channel context

cause - the exception that was caught

http2Ex - the Http2Exception that is embedded in the causality chain. This may be null if it's an unknown exception.

onStreamError

protected void onStreamError(ChannelHandlerContext ctx,
                 Throwable cause,
                 Http2Exception.StreamException http2Ex)

Handler for a stream error. Sends a RST_STREAM frame to the remote endpoint and closes the stream.

Parameters:

ctx - the channel context

cause - the exception that was caught

http2Ex - the Http2Exception.StreamException that is embedded in the causality chain.

frameWriter

protected Http2FrameWriter frameWriter()

writeRstStream

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

Writes a RST_STREAM frame to the remote endpoint and updates the connection state appropriately.

Specified by:

writeRstStream in interface Http2LifecycleManager

writeGoAway

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

Sends a GO_AWAY frame to the remote endpoint and updates the connection state appropriately.

Specified by:

writeGoAway in interface Http2LifecycleManager

decode

protected void decode(ChannelHandlerContext ctx,
          ByteBuf in,
          List<Object> out)
               throws Exception

Description copied from class: ByteToMessageDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error accour