io.netty.handler.codec.http2

Class Http2ConnectionHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.http2.Http2ConnectionHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler, Http2LifecycleManager

Direct Known Subclasses:

Http2FrameCodec, HttpToHttp2ConnectionHandler

public class Http2ConnectionHandler
extends ByteToMessageDecoder
implements Http2LifecycleManager, ChannelOutboundHandler

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

Field Summary

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

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Http2ConnectionHandler(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings)
protected	Http2ConnectionHandler(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings, boolean decoupleCloseAndGoAway)
protected	Http2ConnectionHandler(Http2ConnectionDecoder decoder, Http2ConnectionEncoder encoder, Http2Settings initialSettings, boolean decoupleCloseAndGoAway, boolean flushPreface)

Method Summary

Modifier and Type	Method and Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise) Called once a bind operation is made.
void	channelActive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise) Called once a close operation is made.
void	closeStream(Http2Stream stream, ChannelFuture future) Closes and deactivates the given stream.
void	closeStreamLocal(Http2Stream stream, ChannelFuture future) Closes the local side of the given stream.
void	closeStreamRemote(Http2Stream stream, ChannelFuture future) Closes the remote side of the given stream.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise) Called once a connect operation is made.
Http2Connection	connection()
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) Decode the from one ByteBuf to an other.
Http2ConnectionDecoder	decoder()
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise) Called once a deregister operation is made from the current registered EventLoop.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise) Called once a disconnect operation is made.
Http2ConnectionEncoder	encoder()
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause) Handles Http2Exception objects that were thrown from other handlers.
void	flush(ChannelHandlerContext ctx) Called once a flush operation is made.
protected Http2FrameWriter	frameWriter()
ChannelFuture	goAway(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData, ChannelPromise promise) Prevents the peer from creating streams and close the connection if errorCode is not Http2Error.NO_ERROR.
long	gracefulShutdownTimeoutMillis() Get the amount of time (in milliseconds) this endpoint will wait for all streams to be closed before closing the connection during the graceful shutdown process.
void	gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis) Set the amount of time (in milliseconds) this endpoint will wait for all streams to be closed before closing the connection during the graceful shutdown process.
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	handleServerHeaderDecodeSizeError(ChannelHandlerContext ctx, Http2Stream stream) Notifies client that this server has received headers that are larger than what it is willing to accept.
protected boolean	isGracefulShutdownComplete() Called by the graceful shutdown logic to determine when it is safe to close the connection.
protected void	onConnectionError(ChannelHandlerContext ctx, boolean outbound, Throwable cause, Http2Exception http2Ex) Handler for a connection error.
void	onError(ChannelHandlerContext ctx, boolean outbound, 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, boolean outbound, Throwable cause, Http2Exception.StreamException http2Ex) Handler for a stream error.
void	read(ChannelHandlerContext ctx) Intercepts ChannelHandlerContext.read().
ChannelFuture	resetStream(ChannelHandlerContext ctx, int streamId, long errorCode, ChannelPromise promise) Ensure the stream identified by streamId is reset.
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) Called once a write operation is made.

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

actualReadableBytes, callDecode, channelRead, decodeLast, discardSomeReadBytes, handlerRemoved, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelRegistered, channelUnregistered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerRemoved

Constructor Detail

Http2ConnectionHandler

protected Http2ConnectionHandler(Http2ConnectionDecoder decoder,
                                 Http2ConnectionEncoder encoder,
                                 Http2Settings initialSettings)

Http2ConnectionHandler

protected Http2ConnectionHandler(Http2ConnectionDecoder decoder,
                                 Http2ConnectionEncoder encoder,
                                 Http2Settings initialSettings,
                                 boolean decoupleCloseAndGoAway)

Http2ConnectionHandler

protected Http2ConnectionHandler(Http2ConnectionDecoder decoder,
                                 Http2ConnectionEncoder encoder,
                                 Http2Settings initialSettings,
                                 boolean decoupleCloseAndGoAway,
                                 boolean flushPreface)

Method Detail

gracefulShutdownTimeoutMillis

public long gracefulShutdownTimeoutMillis()

Get the amount of time (in milliseconds) this endpoint will wait for all streams to be closed before closing the connection during the graceful shutdown process. Returns -1 if this connection is configured to wait indefinitely for all streams to close.

gracefulShutdownTimeoutMillis

public void gracefulShutdownTimeoutMillis(long gracefulShutdownTimeoutMillis)

Set the amount of time (in milliseconds) this endpoint will wait for all streams to be closed before closing the connection during the graceful shutdown process.

Parameters:

gracefulShutdownTimeoutMillis - the amount of time (in milliseconds) this endpoint will wait for all streams to be closed before closing the connection during the graceful shutdown process.

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

flush

public void flush(ChannelHandlerContext ctx)

Description copied from interface: ChannelOutboundHandler

Called once a flush operation is made. The flush operation will try to flush out all previous written messages that are pending.

Specified by:

flush in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the flush operation is made

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

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelActive in interface ChannelInboundHandler

Overrides:

channelActive in class ChannelInboundHandlerAdapter

Throws:

Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelInactive in interface ChannelInboundHandler

Overrides:

channelInactive in class ByteToMessageDecoder

Throws:

Exception

channelWritabilityChanged

public void channelWritabilityChanged(ChannelHandlerContext ctx)
                               throws Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelWritabilityChanged in interface ChannelInboundHandler

Overrides:

channelWritabilityChanged in class ChannelInboundHandlerAdapter

Throws:

Exception

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 occurs

bind

public void bind(ChannelHandlerContext ctx,
                 SocketAddress localAddress,
                 ChannelPromise promise)
          throws Exception

Description copied from interface: ChannelOutboundHandler

Called once a bind operation is made.

Specified by:

bind in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the bind operation is made

localAddress - the SocketAddress to which it should bound

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

connect

public void connect(ChannelHandlerContext ctx,
                    SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    ChannelPromise promise)
             throws Exception

Description copied from interface: ChannelOutboundHandler

Called once a connect operation is made.

Specified by:

connect in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the connect operation is made

remoteAddress - the SocketAddress to which it should connect

localAddress - the SocketAddress which is used as source on connect

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

disconnect

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

Description copied from interface: ChannelOutboundHandler

Called once a disconnect operation is made.

Specified by:

disconnect in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the disconnect operation is made

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

close

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

Description copied from interface: ChannelOutboundHandler

Called once a close operation is made.

Specified by:

close in interface ChannelOutboundHandler

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 occurs

deregister

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

Description copied from interface: ChannelOutboundHandler

Called once a deregister operation is made from the current registered EventLoop.

Specified by:

deregister in interface ChannelOutboundHandler

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 occurs

read

public void read(ChannelHandlerContext ctx)
          throws Exception

Description copied from interface: ChannelOutboundHandler

Intercepts ChannelHandlerContext.read().

Specified by:

read in interface ChannelOutboundHandler

Throws:

Exception

write

public void write(ChannelHandlerContext ctx,
                  Object msg,
                  ChannelPromise promise)
           throws Exception

Description copied from interface: ChannelOutboundHandler

Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel.flush() is called

Specified by:

write in interface ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext for which the write operation is made

msg - the message to write

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - thrown if an error occurs

channelReadComplete

public void channelReadComplete(ChannelHandlerContext ctx)
                         throws Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelReadComplete in interface ChannelInboundHandler

Overrides:

channelReadComplete 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

Specified by:

exceptionCaught in interface ChannelInboundHandler

Overrides:

exceptionCaught in class ChannelInboundHandlerAdapter

Throws:

Exception

closeStreamLocal

public void closeStreamLocal(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:

closeStreamLocal in interface Http2LifecycleManager

Parameters:

stream - the stream to be half closed.

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

closeStreamRemote

public void closeStreamRemote(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:

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

Description copied from interface: Http2LifecycleManager

Closes and deactivates the given stream. A listener is also attached to future and upon completion the underlying channel will be closed if Http2Connection.numActiveStreams() is 0.

Specified by:

closeStream in interface Http2LifecycleManager

Parameters:

stream - the stream to be closed and deactivated.

future - when completed if Http2Connection.numActiveStreams() is 0 then the underlying channel will be closed.

onError

public void onError(ChannelHandlerContext ctx,
                    boolean outbound,
                    Throwable cause)

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

Specified by:

onError in interface Http2LifecycleManager

Parameters:

ctx - The context used for communication and buffer allocation if necessary.

outbound - true if the error was caused by an outbound operation and so the corresponding ChannelPromise was failed as well.

cause - the error.

isGracefulShutdownComplete

protected boolean isGracefulShutdownComplete()

Called by the graceful shutdown logic to determine when it is safe to close the connection. Returns true if the graceful shutdown has completed and the connection can be safely closed. This implementation just guarantees that there are no active streams. Subclasses may override to provide additional checks.

onConnectionError

protected void onConnectionError(ChannelHandlerContext ctx,
                                 boolean outbound,
                                 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

outbound - true if the error was caused by an outbound operation.

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,
                             boolean outbound,
                             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

outbound - true if the error was caused by an outbound operation.

cause - the exception that was caught

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

handleServerHeaderDecodeSizeError

protected void handleServerHeaderDecodeSizeError(ChannelHandlerContext ctx,
                                                 Http2Stream stream)

Notifies client that this server has received headers that are larger than what it is willing to accept. Override to change behavior.

Parameters:

ctx - the channel context

stream - the Http2Stream on which the header was received

frameWriter

protected Http2FrameWriter frameWriter()

resetStream

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

Description copied from interface: Http2LifecycleManager

Ensure the stream identified by streamId is reset. If our local state does not indicate the stream has been reset yet then a RST_STREAM will be sent to the peer. If our local state indicates the stream has already been reset then the return status will indicate success without sending anything to the peer.

Specified by:

resetStream in interface Http2LifecycleManager

Parameters:

ctx - The context used for communication and buffer allocation if necessary.

streamId - The identifier of the stream to reset.

errorCode - Justification as to why this stream is being reset. See Http2Error.

promise - Used to indicate the return status of this operation.

Returns:

Will be considered successful when the connection and stream state has been updated, and a RST_STREAM frame has been sent to the peer. If the stream state has already been updated and a RST_STREAM frame has been sent then the return status may indicate success immediately.

goAway

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

Description copied from interface: Http2LifecycleManager

Prevents the peer from creating streams and close the connection if errorCode is not Http2Error.NO_ERROR. After this call the peer is not allowed to create any new streams and the local endpoint will be limited to creating streams with stream identifier <= lastStreamId. This may result in sending a GO_AWAY frame (assuming we have not already sent one with Last-Stream-ID <= lastStreamId), or may just return success if a GO_AWAY has previously been sent.

Specified by:

goAway in interface Http2LifecycleManager

Parameters:

ctx - The context used for communication and buffer allocation if necessary.

lastStreamId - The last stream that the local endpoint is claiming it will accept.

errorCode - The rational as to why the connection is being closed. See Http2Error.

debugData - For diagnostic purposes (carries no semantic value).

promise - Used to indicate the return status of this operation.

Returns:

Will be considered successful when the connection and stream state has been updated, and a GO_AWAY frame has been sent to the peer. If the stream state has already been updated and a GO_AWAY frame has been sent then the return status may indicate success immediately.