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:

io.netty.channel.ChannelHandler, Http2LifecycleManager

Direct Known Subclasses:

HttpToHttp2ConnectionHandler

public class Http2ConnectionHandler
extends io.netty.handler.codec.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

io.netty.handler.codec.ByteToMessageDecoder.Cumulator

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

io.netty.channel.ChannelHandler.Sharable, io.netty.channel.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(io.netty.channel.ChannelHandlerContext ctx)
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
void	close(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	closeLocalSide(Http2Stream stream, io.netty.channel.ChannelFuture future) Closes the local side of the given stream.
void	closeRemoteSide(Http2Stream stream, io.netty.channel.ChannelFuture future) Closes the remote side of the given stream.
void	closeStream(Http2Stream stream, io.netty.channel.ChannelFuture future) Closes the given stream and adds a hook to close the channel after the given future completes.
Http2Connection	connection()
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out)
Http2ConnectionDecoder	decoder()
Http2ConnectionEncoder	encoder()
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause) Handles Http2Exception objects that were thrown from other handlers.
protected Http2FrameWriter	frameWriter()
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
protected void	handlerRemoved0(io.netty.channel.ChannelHandlerContext ctx)
protected void	onConnectionError(io.netty.channel.ChannelHandlerContext ctx, Throwable cause, Http2Exception http2Ex) Handler for a connection error.
void	onException(io.netty.channel.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(io.netty.channel.ChannelHandlerContext ctx, Throwable cause, Http2Exception.StreamException http2Ex) Handler for a stream error.
io.netty.channel.ChannelFuture	writeGoAway(io.netty.channel.ChannelHandlerContext ctx, int lastStreamId, long errorCode, io.netty.buffer.ByteBuf debugData, io.netty.channel.ChannelPromise promise) Sends a GO_AWAY frame to the remote endpoint and updates the connection state appropriately.
io.netty.channel.ChannelFuture	writeRstStream(io.netty.channel.ChannelHandlerContext ctx, int streamId, long errorCode, io.netty.channel.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(io.netty.channel.ChannelHandlerContext ctx)
                   throws Exception

Specified by:

channelActive in interface io.netty.channel.ChannelHandler

Overrides:

channelActive in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

handlerAdded

public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
                  throws Exception

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

handlerRemoved0

protected void handlerRemoved0(io.netty.channel.ChannelHandlerContext ctx)
                        throws Exception

Overrides:

handlerRemoved0 in class io.netty.handler.codec.ByteToMessageDecoder

Throws:

Exception

close

public void close(io.netty.channel.ChannelHandlerContext ctx,
         io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

close in interface io.netty.channel.ChannelHandler

Overrides:

close in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

channelInactive

public void channelInactive(io.netty.channel.ChannelHandlerContext ctx)
                     throws Exception

Specified by:

channelInactive in interface io.netty.channel.ChannelHandler

Overrides:

channelInactive in class io.netty.handler.codec.ByteToMessageDecoder

Throws:

Exception

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                   Throwable cause)
                     throws Exception

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

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

closeLocalSide

public void closeLocalSide(Http2Stream stream,
                  io.netty.channel.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,
                   io.netty.channel.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,
               io.netty.channel.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(io.netty.channel.ChannelHandlerContext ctx,
               Throwable cause)

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

Specified by:

onException in interface Http2LifecycleManager

onConnectionError

protected void onConnectionError(io.netty.channel.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(io.netty.channel.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 io.netty.channel.ChannelFuture writeRstStream(io.netty.channel.ChannelHandlerContext ctx,
                                            int streamId,
                                            long errorCode,
                                            io.netty.channel.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 io.netty.channel.ChannelFuture writeGoAway(io.netty.channel.ChannelHandlerContext ctx,
                                         int lastStreamId,
                                         long errorCode,
                                         io.netty.buffer.ByteBuf debugData,
                                         io.netty.channel.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(io.netty.channel.ChannelHandlerContext ctx,
          io.netty.buffer.ByteBuf in,
          List<Object> out)
               throws Exception

Specified by:

decode in class io.netty.handler.codec.ByteToMessageDecoder

Throws:

Exception