io.netty.example.http2.helloworld.server

类 HelloWorldHttp2Handler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.http2.Http2ConnectionHandler

io.netty.example.http2.helloworld.server.HelloWorldHttp2Handler

所有已实现的接口:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler, Http2FrameListener, Http2LifecycleManager

public final class HelloWorldHttp2Handler
extends Http2ConnectionHandler
implements Http2FrameListener

A simple handler that responds with the message "Hello World!".

嵌套类概要

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

ByteToMessageDecoder.Cumulator

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

ChannelHandler.Sharable

字段概要

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

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

方法概要

限定符和类型	方法和说明
void	exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause) Handles Http2Exception objects that were thrown from other handlers.
int	onDataRead(ChannelHandlerContext ctx, int streamId, ByteBuf data, int padding, boolean endOfStream) Handles an inbound DATA frame.
void	onGoAwayRead(ChannelHandlerContext ctx, int lastStreamId, long errorCode, ByteBuf debugData) Handles an inbound GO_AWAY frame.
void	onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int padding, boolean endOfStream) Handles an inbound HEADERS frame.
void	onHeadersRead(ChannelHandlerContext ctx, int streamId, Http2Headers headers, int streamDependency, short weight, boolean exclusive, int padding, boolean endOfStream) Handles an inbound HEADERS frame with priority information specified.
void	onPingAckRead(ChannelHandlerContext ctx, long data) Handles an inbound PING acknowledgment.
void	onPingRead(ChannelHandlerContext ctx, long data) Handles an inbound PING frame.
void	onPriorityRead(ChannelHandlerContext ctx, int streamId, int streamDependency, short weight, boolean exclusive) Handles an inbound PRIORITY frame.
void	onPushPromiseRead(ChannelHandlerContext ctx, int streamId, int promisedStreamId, Http2Headers headers, int padding) Handles an inbound PUSH_PROMISE frame.
void	onRstStreamRead(ChannelHandlerContext ctx, int streamId, long errorCode) Handles an inbound RST_STREAM frame.
void	onSettingsAckRead(ChannelHandlerContext ctx) Handles an inbound SETTINGS acknowledgment frame.
void	onSettingsRead(ChannelHandlerContext ctx, Http2Settings settings) Handles an inbound SETTINGS frame.
void	onUnknownFrame(ChannelHandlerContext ctx, byte frameType, int streamId, Http2Flags flags, ByteBuf payload) Handler for a frame not defined by the HTTP/2 spec.
void	onWindowUpdateRead(ChannelHandlerContext ctx, int streamId, int windowSizeIncrement) Handles an inbound WINDOW_UPDATE frame.
void	userEventTriggered(ChannelHandlerContext ctx, java.lang.Object evt) Handles the cleartext HTTP upgrade event.

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

bind, channelActive, channelInactive, channelReadComplete, channelWritabilityChanged, close, closeStream, closeStreamLocal, closeStreamRemote, connect, connection, decode, decoder, deregister, disconnect, encoder, flush, frameWriter, goAway, gracefulShutdownTimeoutMillis, gracefulShutdownTimeoutMillis, handlerAdded, handlerRemoved0, handleServerHeaderDecodeSizeError, isGracefulShutdownComplete, onConnectionError, onError, onHttpClientUpgrade, onHttpServerUpgrade, onStreamError, read, resetStream, write

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

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

从类继承的方法 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

方法详细资料

userEventTriggered

public void userEventTriggered(ChannelHandlerContext ctx,
                               java.lang.Object evt)
                        throws java.lang.Exception

Handles the cleartext HTTP upgrade event. If an upgrade occurred, sends a simple response via HTTP/2 on stream 1 (the stream specifically reserved for cleartext HTTP upgrade).

指定者:

userEventTriggered 在接口中 ChannelInboundHandler

覆盖:

userEventTriggered 在类中 ByteToMessageDecoder

抛出:

java.lang.Exception

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
                            java.lang.Throwable cause)
                     throws java.lang.Exception

从类复制的说明: Http2ConnectionHandler

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

指定者:

exceptionCaught 在接口中 ChannelHandler

指定者:

exceptionCaught 在接口中 ChannelInboundHandler

覆盖:

exceptionCaught 在类中 Http2ConnectionHandler

抛出:

java.lang.Exception

onDataRead

public int onDataRead(ChannelHandlerContext ctx,
                      int streamId,
                      ByteBuf data,
                      int padding,
                      boolean endOfStream)

从接口复制的说明: Http2FrameListener

Handles an inbound DATA frame.

指定者:

onDataRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

streamId - the subject stream for the frame.

data - payload buffer for the frame. This buffer will be released by the codec.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

endOfStream - Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

返回:

the number of bytes that have been processed by the application. The returned bytes are used by the inbound flow controller to determine the appropriate time to expand the inbound flow control window (i.e. send WINDOW_UPDATE). Returning a value equal to the length of data + padding will effectively opt-out of application-level flow control for this frame. Returning a value less than the length of data + padding will defer the returning of the processed bytes, which the application must later return via Http2LocalFlowController.consumeBytes(Http2Stream, int). The returned value must be >= 0 and <= data.readableBytes() + padding.

onHeadersRead

public void onHeadersRead(ChannelHandlerContext ctx,
                          int streamId,
                          Http2Headers headers,
                          int padding,
                          boolean endOfStream)

从接口复制的说明: Http2FrameListener

Handles an inbound HEADERS frame.

Only one of the following methods will be called for each HEADERS frame sequence. One will be called when the END_HEADERS flag has been received.

• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)
• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)
• Http2FrameListener.onPushPromiseRead(ChannelHandlerContext, int, int, Http2Headers, int)

To say it another way; the Http2Headers will contain all of the headers for the current message exchange step (additional queuing is not necessary).

指定者:

onHeadersRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

streamId - the subject stream for the frame.

headers - the received headers.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

endOfStream - Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

onHeadersRead

public void onHeadersRead(ChannelHandlerContext ctx,
                          int streamId,
                          Http2Headers headers,
                          int streamDependency,
                          short weight,
                          boolean exclusive,
                          int padding,
                          boolean endOfStream)

从接口复制的说明: Http2FrameListener

Handles an inbound HEADERS frame with priority information specified. Only called if END_HEADERS encountered.

Only one of the following methods will be called for each HEADERS frame sequence. One will be called when the END_HEADERS flag has been received.

• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)
• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)
• Http2FrameListener.onPushPromiseRead(ChannelHandlerContext, int, int, Http2Headers, int)

To say it another way; the Http2Headers will contain all of the headers for the current message exchange step (additional queuing is not necessary).

指定者:

onHeadersRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

streamId - the subject stream for the frame.

headers - the received headers.

streamDependency - the stream on which this stream depends, or 0 if dependent on the connection.

weight - the new weight for the stream.

exclusive - whether or not the stream should be the exclusive dependent of its parent.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

endOfStream - Indicates whether this is the last frame to be sent from the remote endpoint for this stream.

onPriorityRead

public void onPriorityRead(ChannelHandlerContext ctx,
                           int streamId,
                           int streamDependency,
                           short weight,
                           boolean exclusive)

从接口复制的说明: Http2FrameListener

Handles an inbound PRIORITY frame.

Note that is it possible to have this method called and no stream object exist for either streamId, streamDependency, or both. This is because the PRIORITY frame can be sent/received when streams are in the CLOSED state.

指定者:

onPriorityRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

streamId - the subject stream for the frame.

streamDependency - the stream on which this stream depends, or 0 if dependent on the connection.

weight - the new weight for the stream.

exclusive - whether or not the stream should be the exclusive dependent of its parent.

onRstStreamRead

public void onRstStreamRead(ChannelHandlerContext ctx,
                            int streamId,
                            long errorCode)

从接口复制的说明: Http2FrameListener

Handles an inbound RST_STREAM frame.

指定者:

onRstStreamRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

streamId - the stream that is terminating.

errorCode - the error code identifying the type of failure.

onSettingsAckRead

public void onSettingsAckRead(ChannelHandlerContext ctx)

从接口复制的说明: Http2FrameListener

Handles an inbound SETTINGS acknowledgment frame.

指定者:

onSettingsAckRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

onSettingsRead

public void onSettingsRead(ChannelHandlerContext ctx,
                           Http2Settings settings)

从接口复制的说明: Http2FrameListener

Handles an inbound SETTINGS frame.

指定者:

onSettingsRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

settings - the settings received from the remote endpoint.

onPingRead

public void onPingRead(ChannelHandlerContext ctx,
                       long data)

从接口复制的说明: Http2FrameListener

Handles an inbound PING frame.

指定者:

onPingRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

data - the payload of the frame.

onPingAckRead

public void onPingAckRead(ChannelHandlerContext ctx,
                          long data)

从接口复制的说明: Http2FrameListener

Handles an inbound PING acknowledgment.

指定者:

onPingAckRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

data - the payload of the frame.

onPushPromiseRead

public void onPushPromiseRead(ChannelHandlerContext ctx,
                              int streamId,
                              int promisedStreamId,
                              Http2Headers headers,
                              int padding)

从接口复制的说明: Http2FrameListener

Handles an inbound PUSH_PROMISE frame. Only called if END_HEADERS encountered.

Promised requests MUST be authoritative, cacheable, and safe. See [RFC 7540], Section 8.2.

Only one of the following methods will be called for each HEADERS frame sequence. One will be called when the END_HEADERS flag has been received.

• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, boolean)
• Http2FrameListener.onHeadersRead(ChannelHandlerContext, int, Http2Headers, int, short, boolean, int, boolean)
• Http2FrameListener.onPushPromiseRead(ChannelHandlerContext, int, int, Http2Headers, int)

To say it another way; the Http2Headers will contain all of the headers for the current message exchange step (additional queuing is not necessary).

指定者:

onPushPromiseRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

streamId - the stream the frame was sent on.

promisedStreamId - the ID of the promised stream.

headers - the received headers.

padding - additional bytes that should be added to obscure the true content size. Must be between 0 and 256 (inclusive).

onGoAwayRead

public void onGoAwayRead(ChannelHandlerContext ctx,
                         int lastStreamId,
                         long errorCode,
                         ByteBuf debugData)

从接口复制的说明: Http2FrameListener

Handles an inbound GO_AWAY frame.

指定者:

onGoAwayRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

lastStreamId - the last known stream of the remote endpoint.

errorCode - the error code, if abnormal closure.

debugData - application-defined debug data. If this buffer needs to be retained by the listener they must make a copy.

onWindowUpdateRead

public void onWindowUpdateRead(ChannelHandlerContext ctx,
                               int streamId,
                               int windowSizeIncrement)

从接口复制的说明: Http2FrameListener

Handles an inbound WINDOW_UPDATE frame.

指定者:

onWindowUpdateRead 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

streamId - the stream the frame was sent on.

windowSizeIncrement - the increased number of bytes of the remote endpoint's flow control window.

onUnknownFrame

public void onUnknownFrame(ChannelHandlerContext ctx,
                           byte frameType,
                           int streamId,
                           Http2Flags flags,
                           ByteBuf payload)

从接口复制的说明: Http2FrameListener

Handler for a frame not defined by the HTTP/2 spec.

指定者:

onUnknownFrame 在接口中 Http2FrameListener

参数:

ctx - the context from the handler where the frame was read.

frameType - the frame type from the HTTP/2 header.

streamId - the stream the frame was sent on.

flags - the flags in the frame header.

payload - the payload of the frame.