Package io.netty.handler.codec.http3

Class Http3FrameToHttpObjectCodec

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.http3.Http3RequestStreamInboundHandler

io.netty.handler.codec.http3.Http3FrameToHttpObjectCodec

All Implemented Interfaces:

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

public final class Http3FrameToHttpObjectCodec
extends Http3RequestStreamInboundHandler
implements io.netty.channel.ChannelOutboundHandler

This handler converts from Http3RequestStreamFrame to HttpObject, and back. It can be used as an adapter in conjunction with Http3ServerConnectionHandler or Http3ClientConnectionHandler to make http/3 connections backward-compatible with ChannelHandlers expecting HttpObject.

For simplicity, it converts to chunked encoding unless the entire stream is a single header.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
Http3FrameToHttpObjectCodec(boolean isServer)
Http3FrameToHttpObjectCodec(boolean isServer, boolean validateHeaders)

Method Summary

Modifier and Type	Method	Description
void	bind(io.netty.channel.ChannelHandlerContext ctx, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
protected void	channelInputClosed(io.netty.channel.ChannelHandlerContext ctx)	Called once the input is closed and so no more inbound data is received on it.
protected void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Http3DataFrame frame)	Called once a Http3DataFrame is ready for this stream to process.
protected void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Http3HeadersFrame frame)	Called once a Http3HeadersFrame is ready for this stream to process.
void	close(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	connect(io.netty.channel.ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
void	deregister(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	disconnect(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	flush(io.netty.channel.ChannelHandlerContext ctx)
boolean	isSharable()
void	read(io.netty.channel.ChannelHandlerContext ctx)
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)	Encode from an HttpObject to an Http3RequestStreamFrame.

Methods inherited from class io.netty.handler.codec.http3.Http3RequestStreamInboundHandler

channelRead, channelRead, controlStream, exceptionCaught, handleHttp3Exception, handleQuicException, userEventTriggered

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved

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

handlerAdded, handlerRemoved

Constructor Detail

Http3FrameToHttpObjectCodec

public Http3FrameToHttpObjectCodec(boolean isServer,
                                   boolean validateHeaders)

Http3FrameToHttpObjectCodec

public Http3FrameToHttpObjectCodec(boolean isServer)

Method Detail

isSharable

public boolean isSharable()

Overrides:

isSharable in class io.netty.channel.ChannelHandlerAdapter

channelRead

protected void channelRead(io.netty.channel.ChannelHandlerContext ctx,
                           Http3HeadersFrame frame)
                    throws Exception

Description copied from class: Http3RequestStreamInboundHandler

Called once a Http3HeadersFrame is ready for this stream to process.

Specified by:

channelRead in class Http3RequestStreamInboundHandler

Parameters:

ctx - the ChannelHandlerContext of this handler.

frame - the Http3HeadersFrame that was read

Throws:

Exception - thrown if an error happens during processing.

channelRead

protected void channelRead(io.netty.channel.ChannelHandlerContext ctx,
                           Http3DataFrame frame)
                    throws Exception

Description copied from class: Http3RequestStreamInboundHandler

Called once a Http3DataFrame is ready for this stream to process.

Specified by:

channelRead in class Http3RequestStreamInboundHandler

Parameters:

ctx - the ChannelHandlerContext of this handler.

frame - the Http3DataFrame that was read

Throws:

Exception - thrown if an error happens during processing.

channelInputClosed

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

Description copied from class: Http3RequestStreamInboundHandler

Called once the input is closed and so no more inbound data is received on it.

Specified by:

channelInputClosed in class Http3RequestStreamInboundHandler

Parameters:

ctx - the ChannelHandlerContext of this handler.

Throws:

Exception - thrown if an error happens during processing.

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
                  Object msg,
                  io.netty.channel.ChannelPromise promise)
           throws Exception

Encode from an HttpObject to an Http3RequestStreamFrame. This method will be called for each written message that can be handled by this encoder. NOTE: 100-Continue responses that are NOT FullHttpResponse will be rejected.

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext which this handler belongs to

msg - the HttpObject message to encode

Throws:

Exception - is thrown if an error occurs

flush

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

Specified by:

flush in interface io.netty.channel.ChannelOutboundHandler

bind

public void bind(io.netty.channel.ChannelHandlerContext ctx,
                 SocketAddress localAddress,
                 io.netty.channel.ChannelPromise promise)

Specified by:

bind in interface io.netty.channel.ChannelOutboundHandler

connect

public void connect(io.netty.channel.ChannelHandlerContext ctx,
                    SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    io.netty.channel.ChannelPromise promise)

Specified by:

connect in interface io.netty.channel.ChannelOutboundHandler

disconnect

public void disconnect(io.netty.channel.ChannelHandlerContext ctx,
                       io.netty.channel.ChannelPromise promise)

Specified by:

disconnect in interface io.netty.channel.ChannelOutboundHandler

close

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

Specified by:

close in interface io.netty.channel.ChannelOutboundHandler

deregister

public void deregister(io.netty.channel.ChannelHandlerContext ctx,
                       io.netty.channel.ChannelPromise promise)

Specified by:

deregister in interface io.netty.channel.ChannelOutboundHandler

read

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

Specified by:

read in interface io.netty.channel.ChannelOutboundHandler

Throws:

Exception