io.netty.handler.codec.http2

类 Http2ConnectionHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.http2.Http2ConnectionHandler

所有已实现的接口:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler, io.netty.handler.codec.http2.Http2LifecycleManager

@UnstableApi
public class Http2ConnectionHandler
extends io.netty.handler.codec.ByteToMessageDecoder
implements io.netty.handler.codec.http2.Http2LifecycleManager, io.netty.channel.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

嵌套类概要

从类继承的嵌套类/接口 io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.ByteToMessageDecoder.Cumulator

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

字段概要

字段

限定符和类型	字段和说明
static io.prometheus.client.Histogram	flushCtxFlushDuration
static io.prometheus.client.Histogram	flushFlowControlWriteDuration

从类继承的字段 io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造器概要

构造器

限定符	构造器和说明
protected	Http2ConnectionHandler(io.netty.handler.codec.http2.Http2ConnectionDecoder decoder, io.netty.handler.codec.http2.Http2ConnectionEncoder encoder, io.netty.handler.codec.http2.Http2Settings initialSettings)
protected	Http2ConnectionHandler(io.netty.handler.codec.http2.Http2ConnectionDecoder decoder, io.netty.handler.codec.http2.Http2ConnectionEncoder encoder, io.netty.handler.codec.http2.Http2Settings initialSettings, boolean decoupleCloseAndGoAway)

方法概要

限定符和类型	方法和说明
void	bind(io.netty.channel.ChannelHandlerContext ctx, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
void	channelReadComplete(io.netty.channel.ChannelHandlerContext ctx)
void	channelWritabilityChanged(io.netty.channel.ChannelHandlerContext ctx)
void	close(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	closeStream(io.netty.handler.codec.http2.Http2Stream stream, io.netty.channel.ChannelFuture future)
void	closeStreamLocal(io.netty.handler.codec.http2.Http2Stream stream, io.netty.channel.ChannelFuture future) Closes the local side of the given stream.
void	closeStreamRemote(io.netty.handler.codec.http2.Http2Stream stream, io.netty.channel.ChannelFuture future) Closes the remote side of the given stream.
void	connect(io.netty.channel.ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, io.netty.channel.ChannelPromise promise)
io.netty.handler.codec.http2.Http2Connection	connection()
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out)
io.netty.handler.codec.http2.Http2ConnectionDecoder	decoder()
void	deregister(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
void	disconnect(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
io.netty.handler.codec.http2.Http2ConnectionEncoder	encoder()
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause) Handles Http2Exception objects that were thrown from other handlers.
void	flush(io.netty.channel.ChannelHandlerContext ctx)
protected io.netty.handler.codec.http2.Http2FrameWriter	frameWriter()
io.netty.channel.ChannelFuture	goAway(io.netty.channel.ChannelHandlerContext ctx, int lastStreamId, long errorCode, io.netty.buffer.ByteBuf debugData, io.netty.channel.ChannelPromise promise)
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(io.netty.channel.ChannelHandlerContext ctx)
protected void	handlerRemoved0(io.netty.channel.ChannelHandlerContext ctx)
protected void	handleServerHeaderDecodeSizeError(io.netty.channel.ChannelHandlerContext ctx, io.netty.handler.codec.http2.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(io.netty.channel.ChannelHandlerContext ctx, boolean outbound, Throwable cause, io.netty.handler.codec.http2.Http2Exception http2Ex) Handler for a connection error.
void	onError(io.netty.channel.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(io.netty.handler.codec.http2.Http2Settings settings) Handles the server-side (cleartext) upgrade from HTTP to HTTP/2.
protected void	onStreamError(io.netty.channel.ChannelHandlerContext ctx, boolean outbound, Throwable cause, io.netty.handler.codec.http2.Http2Exception.StreamException http2Ex) Handler for a stream error.
void	read(io.netty.channel.ChannelHandlerContext ctx)
io.netty.channel.ChannelFuture	resetStream(io.netty.channel.ChannelHandlerContext ctx, int streamId, long errorCode, io.netty.channel.ChannelPromise promise)
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise)

从类继承的方法 io.netty.handler.codec.ByteToMessageDecoder

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

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelRegistered, channelUnregistered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

handlerRemoved

字段详细资料

flushFlowControlWriteDuration

public static final io.prometheus.client.Histogram flushFlowControlWriteDuration

flushCtxFlushDuration

public static final io.prometheus.client.Histogram flushCtxFlushDuration

构造器详细资料

Http2ConnectionHandler

protected Http2ConnectionHandler(io.netty.handler.codec.http2.Http2ConnectionDecoder decoder,
                                 io.netty.handler.codec.http2.Http2ConnectionEncoder encoder,
                                 io.netty.handler.codec.http2.Http2Settings initialSettings)

Http2ConnectionHandler

protected Http2ConnectionHandler(io.netty.handler.codec.http2.Http2ConnectionDecoder decoder,
                                 io.netty.handler.codec.http2.Http2ConnectionEncoder encoder,
                                 io.netty.handler.codec.http2.Http2Settings initialSettings,
                                 boolean decoupleCloseAndGoAway)

方法详细资料

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.

参数:

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 io.netty.handler.codec.http2.Http2Connection connection()

decoder

public io.netty.handler.codec.http2.Http2ConnectionDecoder decoder()

encoder

public io.netty.handler.codec.http2.Http2ConnectionEncoder encoder()

onHttpClientUpgrade

public void onHttpClientUpgrade()
                         throws io.netty.handler.codec.http2.Http2Exception

Handles the client-side (cleartext) upgrade from HTTP to HTTP/2. Reserves local stream 1 for the HTTP/2 response.

抛出:

io.netty.handler.codec.http2.Http2Exception

onHttpServerUpgrade

public void onHttpServerUpgrade(io.netty.handler.codec.http2.Http2Settings settings)
                         throws io.netty.handler.codec.http2.Http2Exception

Handles the server-side (cleartext) upgrade from HTTP to HTTP/2.

参数:

settings - the settings for the remote endpoint.

抛出:

io.netty.handler.codec.http2.Http2Exception

flush

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

指定者:

flush 在接口中 io.netty.channel.ChannelOutboundHandler

handlerAdded

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

指定者:

handlerAdded 在接口中 io.netty.channel.ChannelHandler

覆盖:

handlerAdded 在类中 io.netty.channel.ChannelHandlerAdapter

抛出:

Exception

handlerRemoved0

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

覆盖:

handlerRemoved0 在类中 io.netty.handler.codec.ByteToMessageDecoder

抛出:

Exception

channelActive

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

指定者:

channelActive 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

channelActive 在类中 io.netty.channel.ChannelInboundHandlerAdapter

抛出:

Exception

channelInactive

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

指定者:

channelInactive 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

channelInactive 在类中 io.netty.handler.codec.ByteToMessageDecoder

抛出:

Exception

channelWritabilityChanged

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

指定者:

channelWritabilityChanged 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

channelWritabilityChanged 在类中 io.netty.channel.ChannelInboundHandlerAdapter

抛出:

Exception

decode

protected void decode(io.netty.channel.ChannelHandlerContext ctx,
                      io.netty.buffer.ByteBuf in,
                      List<Object> out)
               throws Exception

指定者:

decode 在类中 io.netty.handler.codec.ByteToMessageDecoder

抛出:

Exception

bind

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

指定者:

bind 在接口中 io.netty.channel.ChannelOutboundHandler

抛出:

Exception

connect

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

指定者:

connect 在接口中 io.netty.channel.ChannelOutboundHandler

抛出:

Exception

disconnect

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

指定者:

disconnect 在接口中 io.netty.channel.ChannelOutboundHandler

抛出:

Exception

close

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

指定者:

close 在接口中 io.netty.channel.ChannelOutboundHandler

抛出:

Exception

deregister

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

指定者:

deregister 在接口中 io.netty.channel.ChannelOutboundHandler

抛出:

Exception

read

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

指定者:

read 在接口中 io.netty.channel.ChannelOutboundHandler

抛出:

Exception

write

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

指定者:

write 在接口中 io.netty.channel.ChannelOutboundHandler

抛出:

Exception

channelReadComplete

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

指定者:

channelReadComplete 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

channelReadComplete 在类中 io.netty.handler.codec.ByteToMessageDecoder

抛出:

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.

指定者:

exceptionCaught 在接口中 io.netty.channel.ChannelHandler

指定者:

exceptionCaught 在接口中 io.netty.channel.ChannelInboundHandler

覆盖:

exceptionCaught 在类中 io.netty.channel.ChannelInboundHandlerAdapter

抛出:

Exception

closeStreamLocal

public void closeStreamLocal(io.netty.handler.codec.http2.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.

指定者:

closeStreamLocal 在接口中 io.netty.handler.codec.http2.Http2LifecycleManager

参数:

stream - the stream to be half closed.

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

closeStreamRemote

public void closeStreamRemote(io.netty.handler.codec.http2.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.

指定者:

closeStreamRemote 在接口中 io.netty.handler.codec.http2.Http2LifecycleManager

参数:

stream - the stream to be half closed.

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

closeStream

public void closeStream(io.netty.handler.codec.http2.Http2Stream stream,
                        io.netty.channel.ChannelFuture future)

指定者:

closeStream 在接口中 io.netty.handler.codec.http2.Http2LifecycleManager

onError

public void onError(io.netty.channel.ChannelHandlerContext ctx,
                    boolean outbound,
                    Throwable cause)

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

指定者:

onError 在接口中 io.netty.handler.codec.http2.Http2LifecycleManager

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(io.netty.channel.ChannelHandlerContext ctx,
                                 boolean outbound,
                                 Throwable cause,
                                 io.netty.handler.codec.http2.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.

参数:

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(io.netty.channel.ChannelHandlerContext ctx,
                             boolean outbound,
                             Throwable cause,
                             io.netty.handler.codec.http2.Http2Exception.StreamException http2Ex)

Handler for a stream error. Sends a RST_STREAM frame to the remote endpoint and closes the stream.

参数:

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(io.netty.channel.ChannelHandlerContext ctx,
                                                 io.netty.handler.codec.http2.Http2Stream stream)

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

参数:

ctx - the channel context

stream - the Http2Stream on which the header was received

frameWriter

protected io.netty.handler.codec.http2.Http2FrameWriter frameWriter()

resetStream

public io.netty.channel.ChannelFuture resetStream(io.netty.channel.ChannelHandlerContext ctx,
                                                  int streamId,
                                                  long errorCode,
                                                  io.netty.channel.ChannelPromise promise)

指定者:

resetStream 在接口中 io.netty.handler.codec.http2.Http2LifecycleManager

goAway

public io.netty.channel.ChannelFuture goAway(io.netty.channel.ChannelHandlerContext ctx,
                                             int lastStreamId,
                                             long errorCode,
                                             io.netty.buffer.ByteBuf debugData,
                                             io.netty.channel.ChannelPromise promise)

指定者:

goAway 在接口中 io.netty.handler.codec.http2.Http2LifecycleManager