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:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public final class Http3FrameToHttpObjectCodec
extends Http3RequestStreamInboundHandler
implements 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 ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Called once a bind operation is made.
protected void	channelInputClosed(ChannelHandlerContext ctx)	Called once the input is closed and so no more inbound data is received on it.
protected void	channelRead(ChannelHandlerContext ctx, Http3DataFrame frame)	Called once a Http3DataFrame is ready for this stream to process.
protected void	channelRead(ChannelHandlerContext ctx, Http3HeadersFrame frame)	Called once a Http3HeadersFrame is ready for this stream to process.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Called once a close operation is made.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Called once a connect operation is made.
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.
void	flush(ChannelHandlerContext ctx)	Called once a flush operation is made.
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.
void	read(ChannelHandlerContext ctx)	Intercepts ChannelHandlerContext.read().
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Encode from an HttpObject to an Http3RequestStreamFrame.

Methods inherited from class Http3RequestStreamInboundHandler

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

Modifier and Type	Method	Description
protected void	channelRead(ChannelHandlerContext ctx, Http3UnknownFrame frame)	Called once a Http3UnknownFrame is ready for this stream to process.
final void	channelRead(ChannelHandlerContext ctx, Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected final @Nullable QuicStreamChannel	controlStream(ChannelHandlerContext ctx)	Return the local control stream for this HTTP/3 connection.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
protected void	handleHttp3Exception(ChannelHandlerContext ctx, Http3Exception exception)	Called once a Http3Exception should be handled.
protected void	handleQuicException(ChannelHandlerContext ctx, QuicException exception)	Called once a QuicException should be handled.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged

Modifier and Type	Method	Description
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	channelRegistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() 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.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.

Methods inherited from class Object

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

Constructor Details

Http3FrameToHttpObjectCodec

public Http3FrameToHttpObjectCodec(boolean isServer,
 boolean validateHeaders)

Http3FrameToHttpObjectCodec

public Http3FrameToHttpObjectCodec(boolean isServer)

Method Details

isSharable

public boolean isSharable()

Description copied from class: ChannelHandlerAdapter

Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Overrides:

isSharable in class ChannelHandlerAdapter

channelRead

protected void channelRead(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(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(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(ChannelHandlerContext ctx,
 Object msg,
 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 ChannelOutboundHandler

Parameters:

ctx - the ChannelHandlerContext which this handler belongs to

msg - the HttpObject message to encode

promise - the ChannelPromise to notify once the operation completes

Throws:

Exception - is thrown if an error occurs

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

bind

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

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

connect

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

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

disconnect

public void disconnect(ChannelHandlerContext ctx,
 ChannelPromise promise)

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

close

public void close(ChannelHandlerContext ctx,
 ChannelPromise promise)

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

deregister

public void deregister(ChannelHandlerContext ctx,
 ChannelPromise promise)

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

read

public void read(ChannelHandlerContext ctx)
          throws Exception

Description copied from interface: ChannelOutboundHandler

Intercepts ChannelHandlerContext.read().

Specified by:

read in interface ChannelOutboundHandler

Throws:

Exception