io.netty.handler.codec.http2

Class Http2MultiplexCodec

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.http2.Http2MultiplexCodec

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler

@UnstableApi
public final class Http2MultiplexCodec
extends io.netty.channel.ChannelDuplexHandler

An HTTP/2 handler that creates child channels for each stream.

When a new stream is created, a new Channel is created for it. Applications send and receive Http2StreamFrames on the created channel. ByteBufs cannot be processed by the channel; all writes that reach the head of the pipeline must be an instance of Http2StreamFrame. Writes that reach the head of the pipeline are processed directly by this handler and cannot be intercepted.

The child channel will be notified of user events that impact the stream, such as Http2GoAwayFrame and Http2ResetFrame, as soon as they occur. Although Http2GoAwayFrame and Http2ResetFrame signify that the remote is ignoring further communication, closing of the channel is delayed until any inbound queue is drained with Channel.read(), which follows the default behavior of channels in Netty. Applications are free to close the channel in response to such events if they don't have use for any queued messages.

Outbound streams are supported via the Http2StreamChannelBootstrap.

ChannelConfig.setMaxMessagesPerRead(int) and ChannelConfig.setAutoRead(boolean) are supported.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
Http2MultiplexCodec(boolean server, Http2StreamChannelBootstrap bootstrap) Construct a new handler whose child channels run in a different event loop.

Method Summary

Methods

Modifier and Type	Method and Description
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)
void	channelReadComplete(io.netty.channel.ChannelHandlerContext ctx) Notifies any child streams of the read completion.
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
void	flush(io.netty.channel.ChannelHandlerContext ctx)
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
void	userEventTriggered(io.netty.channel.ChannelHandlerContext ctx, Object evt)

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, read, write

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRegistered, channelUnregistered, channelWritabilityChanged

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

handlerRemoved, 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

Http2MultiplexCodec

public Http2MultiplexCodec(boolean server,
                   Http2StreamChannelBootstrap bootstrap)

Construct a new handler whose child channels run in a different event loop.

Parameters:

server - true this is a server

bootstrap - bootstrap used to instantiate child channels for remotely-created streams.

Method Detail

handlerAdded

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

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

exceptionCaught

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

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Specified by:

exceptionCaught in interface io.netty.channel.ChannelInboundHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter

flush

public void flush(io.netty.channel.ChannelHandlerContext ctx)

Specified by:

flush in interface io.netty.channel.ChannelOutboundHandler

Overrides:

flush in class io.netty.channel.ChannelDuplexHandler

channelRead

public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
               Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

userEventTriggered

public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
                      Object evt)
                        throws Exception

Specified by:

userEventTriggered in interface io.netty.channel.ChannelInboundHandler

Overrides:

userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

channelReadComplete

public void channelReadComplete(io.netty.channel.ChannelHandlerContext ctx)

Notifies any child streams of the read completion.

Specified by:

channelReadComplete in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelReadComplete in class io.netty.channel.ChannelInboundHandlerAdapter