io.netty.handler.codec.http2

类 Http2ServerUpgradeCodec

java.lang.Object

io.netty.handler.codec.http2.Http2ServerUpgradeCodec

所有已实现的接口:

HttpServerUpgradeHandler.UpgradeCodec

@UnstableApi
public class Http2ServerUpgradeCodec
extends java.lang.Object
implements HttpServerUpgradeHandler.UpgradeCodec

Server-side codec for performing a cleartext upgrade from HTTP/1.x to HTTP/2.

构造器概要

构造器

构造器和说明
Http2ServerUpgradeCodec(Http2ConnectionHandler connectionHandler) Creates the codec using a default name for the connection handler when adding to the pipeline.
Http2ServerUpgradeCodec(Http2FrameCodec http2Codec, ChannelHandler... handlers) Creates the codec using a default name for the connection handler when adding to the pipeline.
Http2ServerUpgradeCodec(Http2MultiplexCodec http2Codec) Creates the codec using a default name for the connection handler when adding to the pipeline.
Http2ServerUpgradeCodec(java.lang.String handlerName, Http2ConnectionHandler connectionHandler) Creates the codec providing an upgrade to the given handler for HTTP/2.
Http2ServerUpgradeCodec(java.lang.String handlerName, Http2MultiplexCodec http2Codec) Creates the codec providing an upgrade to the given handler for HTTP/2.

方法概要

限定符和类型	方法和说明
boolean	prepareUpgradeResponse(ChannelHandlerContext ctx, FullHttpRequest upgradeRequest, HttpHeaders headers) Prepares the upgradeHeaders for a protocol update based upon the contents of upgradeRequest.
java.util.Collection<java.lang.CharSequence>	requiredUpgradeHeaders() Gets all protocol-specific headers required by this protocol for a successful upgrade.
void	upgradeTo(ChannelHandlerContext ctx, FullHttpRequest upgradeRequest) Performs an HTTP protocol upgrade from the source codec.

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

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

构造器详细资料

Http2ServerUpgradeCodec

public Http2ServerUpgradeCodec(Http2ConnectionHandler connectionHandler)

Creates the codec using a default name for the connection handler when adding to the pipeline.

参数:

connectionHandler - the HTTP/2 connection handler

Http2ServerUpgradeCodec

public Http2ServerUpgradeCodec(Http2MultiplexCodec http2Codec)

Creates the codec using a default name for the connection handler when adding to the pipeline.

参数:

http2Codec - the HTTP/2 multiplexing handler.

Http2ServerUpgradeCodec

public Http2ServerUpgradeCodec(java.lang.String handlerName,
                               Http2ConnectionHandler connectionHandler)

Creates the codec providing an upgrade to the given handler for HTTP/2.

参数:

handlerName - the name of the HTTP/2 connection handler to be used in the pipeline, or null to auto-generate the name

connectionHandler - the HTTP/2 connection handler

Http2ServerUpgradeCodec

public Http2ServerUpgradeCodec(java.lang.String handlerName,
                               Http2MultiplexCodec http2Codec)

Creates the codec providing an upgrade to the given handler for HTTP/2.

参数:

handlerName - the name of the HTTP/2 connection handler to be used in the pipeline.

http2Codec - the HTTP/2 multiplexing handler.

Http2ServerUpgradeCodec

public Http2ServerUpgradeCodec(Http2FrameCodec http2Codec,
                               ChannelHandler... handlers)

Creates the codec using a default name for the connection handler when adding to the pipeline.

参数:

http2Codec - the HTTP/2 frame handler.

handlers - the handlers that will handle the Http2Frames.

方法详细资料

requiredUpgradeHeaders

public java.util.Collection<java.lang.CharSequence> requiredUpgradeHeaders()

从接口复制的说明: HttpServerUpgradeHandler.UpgradeCodec

Gets all protocol-specific headers required by this protocol for a successful upgrade. Any supplied header will be required to appear in the HttpHeaderNames.CONNECTION header as well.

指定者:

requiredUpgradeHeaders 在接口中 HttpServerUpgradeHandler.UpgradeCodec

prepareUpgradeResponse

public boolean prepareUpgradeResponse(ChannelHandlerContext ctx,
                                      FullHttpRequest upgradeRequest,
                                      HttpHeaders headers)

从接口复制的说明: HttpServerUpgradeHandler.UpgradeCodec

Prepares the upgradeHeaders for a protocol update based upon the contents of upgradeRequest. This method returns a boolean value to proceed or abort the upgrade in progress. If false is returned, the upgrade is aborted and the upgradeRequest will be passed through the inbound pipeline as if no upgrade was performed. If true is returned, the upgrade will proceed to the next step which invokes HttpServerUpgradeHandler.UpgradeCodec.upgradeTo(io.netty.channel.ChannelHandlerContext, io.netty.handler.codec.http.FullHttpRequest). When returning true, you can add headers to the upgradeHeaders so that they are added to the 101 Switching protocols response.

指定者:

prepareUpgradeResponse 在接口中 HttpServerUpgradeHandler.UpgradeCodec

upgradeTo

public void upgradeTo(ChannelHandlerContext ctx,
                      FullHttpRequest upgradeRequest)

从接口复制的说明: HttpServerUpgradeHandler.UpgradeCodec

Performs an HTTP protocol upgrade from the source codec. This method is responsible for adding all handlers required for the new protocol.

指定者:

upgradeTo 在接口中 HttpServerUpgradeHandler.UpgradeCodec

参数:

ctx - the context for the current handler.

upgradeRequest - the request that triggered the upgrade to this protocol.