Top Description Inners Fields Constructors Methods

io.netty5.handler.codec.http

public Class HttpClientUpgradeHandler<C extends io.netty5.handler.codec.http.HttpContent<C>>

Class Inheritance

extends HttpObjectAggregator<C extends HttpContent<C>>

java.lang.Object
io.netty5.channel.ChannelHandlerAdapter
io.netty5.handler.codec.MessageToMessageDecoder
io.netty5.handler.codec.MessageAggregator
io.netty5.handler.codec.http.HttpObjectAggregator
io.netty5.handler.codec.http.HttpClientUpgradeHandler

Imports

io.netty5.channel.internal.DelegatingChannelHandlerContext, io.netty5.util.Send, .AsciiString, io.netty5.channel.ChannelHandlerContext, io.netty5.util.concurrent.Future, java.util.Collection, .LinkedHashSet, .Set

Client-side handler for handling an HTTP upgrade handshake to another protocol. When the first HTTP request is sent, this handler will add all appropriate headers to perform an upgrade to the new protocol. If the upgrade fails (i.e. response is not 101 Switching Protocols), this handler simply removes itself from the pipeline. If the upgrade is successful, upgrades the pipeline to the new protocol.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	HttpClientUpgradeHandler.SourceCodec The source codec that is used in the pipeline initially.
public static interface	HttpClientUpgradeHandler.UpgradeCodec A codec that the source can be upgraded to.
public static enum	HttpClientUpgradeHandler.UpgradeEvent User events that are fired to notify about upgrade status.

Field Summary

Modifier and Type	Field and Description
private final HttpClientUpgradeHandler.SourceCodec	sourceCodec
private final HttpClientUpgradeHandler.UpgradeCodec	upgradeCodec
private boolean	upgradeRequested

Constructor Summary

Access	Constructor and Description
public	HttpClientUpgradeHandler(HttpClientUpgradeHandler.SourceCodec the codec that is being used initially. sourceCodec, HttpClientUpgradeHandler.UpgradeCodec the codec that the client would like to upgrade to. upgradeCodec, int the maximum length of the aggregated content. maxContentLength) Constructs the client upgrade handler.

Method Summary

Modifier and Type	Method and Description
protected void	decode(final ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to ctx, HttpObject the message to decode to another one msg) Overrides io.netty5.handler.codec.MessageAggregator.decode. Decode from one message to another.
private static void	removeThisHandler(ChannelHandlerContext ctx)
private void	setUpgradeRequestHeaders(ChannelHandlerContext ctx, HttpRequest request) Adds all upgrade request headers necessary for an upgrade to the supported protocols.
private void	tryUpgrade(ChannelHandlerContext ctx, FullHttpResponse response)
public Future<Void>	write(ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made ctx, Object the message to write msg) Overrides default io.netty5.channel.ChannelHandler.write. Called once a write operation is made.

Inherited from io.netty5.handler.codec.http.HttpObjectAggregator:: aggregate beginAggregation channelExceptionCaught closeAfterContinueResponse finishAggregation handleOversizedMessage ignoreContentAfterContinueResponse isAggregated isContentLengthInvalid isLastContentMessage lengthForAggregation lengthForContent newContinueResponse tryContentMessage tryStartMessage

Field Detail

sourceCodec	back to summary
private final HttpClientUpgradeHandler.SourceCodec sourceCodec

upgradeCodec	back to summary
private final HttpClientUpgradeHandler.UpgradeCodec upgradeCodec

upgradeRequested	back to summary
private boolean upgradeRequested

Constructor Detail

HttpClientUpgradeHandler	back to summary
public HttpClientUpgradeHandler(HttpClientUpgradeHandler.SourceCodec sourceCodec, HttpClientUpgradeHandler.UpgradeCodec upgradeCodec, int maxContentLength) Constructs the client upgrade handler. Parameters sourceCodec:HttpClientUpgradeHandler.SourceCodec the codec that is being used initially. upgradeCodec:HttpClientUpgradeHandler.UpgradeCodec the codec that the client would like to upgrade to. maxContentLength:int the maximum length of the aggregated content.

HttpClientUpgradeHandler

back to summary

public HttpClientUpgradeHandler(HttpClientUpgradeHandler.SourceCodec sourceCodec, HttpClientUpgradeHandler.UpgradeCodec upgradeCodec, int maxContentLength)

Constructs the client upgrade handler.

Parameters

sourceCodec:HttpClientUpgradeHandler.SourceCodec: the codec that is being used initially.
upgradeCodec:HttpClientUpgradeHandler.UpgradeCodec: the codec that the client would like to upgrade to.
maxContentLength:int: the maximum length of the aggregated content.

Method Detail

decode back to summary

decode	back to summary
protected void decode(final ChannelHandlerContext ctx, HttpObject msg) throws Exception Overrides io.netty5.handler.codec.MessageAggregator.decode. Doc from io.netty5.handler.codec.MessageToMessageDecoder.decode. Decode from one message to another. This method will be called for each written message that can be handled by this decoder. The message will be disposed of after this call. Subclasses that wish to sometimes pass messages through, should instead override the `decodeAndClose(ChannelHandlerContext, Object)` method. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to msg:HttpObject the message to decode to another one Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(final ChannelHandlerContext ctx, HttpObject msg) throws Exception

Overrides io.netty5.handler.codec.MessageAggregator.decode.

Doc from io.netty5.handler.codec.MessageToMessageDecoder.decode.

Decode from one message to another. This method will be called for each written message that can be handled by this decoder.

The message will be disposed of after this call.

Subclasses that wish to sometimes pass messages through, should instead override the decodeAndClose(ChannelHandlerContext, Object) method.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageDecoder belongs to
msg:HttpObject: the message to decode to another one

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

removeThisHandler	back to summary
private static void removeThisHandler(ChannelHandlerContext ctx)

setUpgradeRequestHeaders	back to summary
private void setUpgradeRequestHeaders(ChannelHandlerContext ctx, HttpRequest request) Adds all upgrade request headers necessary for an upgrade to the supported protocols.

tryUpgrade	back to summary
private void tryUpgrade(ChannelHandlerContext ctx, FullHttpResponse response)

write back to summary

write	back to summary
public Future<Void> write(ChannelHandlerContext ctx, Object msg) Overrides default io.netty5.channel.ChannelHandler.write. Doc from io.netty5.channel.ChannelHandler.write. Called once a write operation is made. The write operation will write the messages through the `ChannelPipeline`. Those are then ready to be flushed to the actual `Channel` once `Channel#flush()` is called. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` for which the write operation is made msg:Object the message to write Returns:Future<Void> the `Future` which will be notified once the operation completes. Annotations @Override

public Future<Void> write(ChannelHandlerContext ctx, Object msg)

Overrides default io.netty5.channel.ChannelHandler.write.

Doc from io.netty5.channel.ChannelHandler.write.

Called once a write operation is made. The write operation will write the messages through the ChannelPipeline. Those are then ready to be flushed to the actual Channel once Channel#flush() is called.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext for which the write operation is made
msg:Object: the message to write

Returns:Future<Void>

the Future which will be notified once the operation completes.

Annotations

@Override

io.netty5.handler.codec.http back to summary

public Interface HttpClientUpgradeHandler.SourceCodec

Known Direct Implementers: io.netty5.handler.codec.http.HttpClientCodec

The source codec that is used in the pipeline initially.

Method Summary

Modifier and Type	Method and Description
public void	prepareUpgradeFrom(ChannelHandlerContext ctx) Removes or disables the encoder of this codec so that the `UpgradeCodec` can send an initial greeting (if any).
public void	upgradeFrom(ChannelHandlerContext ctx) Removes this codec (i.e. all associated handlers) from the pipeline.

Method Detail

prepareUpgradeFrom	back to summary
public void prepareUpgradeFrom(ChannelHandlerContext ctx) Removes or disables the encoder of this codec so that the `UpgradeCodec` can send an initial greeting (if any).

upgradeFrom	back to summary
public void upgradeFrom(ChannelHandlerContext ctx) Removes this codec (i.e. all associated handlers) from the pipeline.

io.netty5.handler.codec.http back to summary

public Interface HttpClientUpgradeHandler.UpgradeCodec

A codec that the source can be upgraded to.

Method Summary

Modifier and Type	Method and Description
public CharSequence	protocol() Returns the name of the protocol supported by this codec, as indicated by the `'UPGRADE'` header.
public Collection<CharSequence>	setUpgradeHeaders(ChannelHandlerContext ctx, HttpRequest upgradeRequest) Sets any protocol-specific headers required to the upgrade request.
public void	upgradeTo(ChannelHandlerContext the context for the current handler. ctx, Send<FullHttpResponse> the 101 Switching Protocols response that indicates that the server has switched to this protocol. upgradeResponse) Performs an HTTP protocol upgrade from the source codec.

Method Detail

protocol	back to summary
public CharSequence protocol() Returns the name of the protocol supported by this codec, as indicated by the `'UPGRADE'` header.

setUpgradeHeaders	back to summary
public Collection<CharSequence> setUpgradeHeaders(ChannelHandlerContext ctx, HttpRequest upgradeRequest) Sets any protocol-specific headers required to the upgrade request. Returns the names of all headers that were added. These headers will be used to populate the CONNECTION header.

upgradeTo	back to summary
public void upgradeTo(ChannelHandlerContext ctx, Send<FullHttpResponse> upgradeResponse) throws Exception Performs an HTTP protocol upgrade from the source codec. This method is responsible for adding all handlers required for the new protocol. Parameters ctx:ChannelHandlerContext the context for the current handler. upgradeResponse:Send<FullHttpResponse> the 101 Switching Protocols response that indicates that the server has switched to this protocol.

upgradeTo

back to summary

public void upgradeTo(ChannelHandlerContext ctx, Send<FullHttpResponse> upgradeResponse) throws Exception

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

Parameters

ctx:ChannelHandlerContext: the context for the current handler.
upgradeResponse:Send<FullHttpResponse>: the 101 Switching Protocols response that indicates that the server has switched to this protocol.

io.netty5.handler.codec.http back to summary

public final Enum HttpClientUpgradeHandler.UpgradeEvent

Class Inheritance

extends Enum<HttpClientUpgradeHandler.UpgradeEvent>

java.lang.Object
java.lang.Enum
io.netty5.handler.codec.http.HttpClientUpgradeHandler.UpgradeEvent

User events that are fired to notify about upgrade status.

Field Summary

Modifier and Type	Field and Description
public static final HttpClientUpgradeHandler.UpgradeEvent	UPGRADE_ISSUED The Upgrade request was sent to the server.
public static final HttpClientUpgradeHandler.UpgradeEvent	UPGRADE_REJECTED The Upgrade was unsuccessful due to the server not issuing with a 101 Switching Protocols response.
public static final HttpClientUpgradeHandler.UpgradeEvent	UPGRADE_SUCCESSFUL The Upgrade to the new protocol was successful.

Constructor Summary

Access	Constructor and Description
private	UpgradeEvent()

Method Summary

Modifier and Type	Method and Description
public static HttpClientUpgradeHandler.UpgradeEvent	valueOf(String name)
public static HttpClientUpgradeHandler.UpgradeEvent[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

UPGRADE_ISSUED	back to summary
public static final HttpClientUpgradeHandler.UpgradeEvent UPGRADE_ISSUED The Upgrade request was sent to the server.

UPGRADE_REJECTED	back to summary
public static final HttpClientUpgradeHandler.UpgradeEvent UPGRADE_REJECTED The Upgrade was unsuccessful due to the server not issuing with a 101 Switching Protocols response.

UPGRADE_SUCCESSFUL	back to summary
public static final HttpClientUpgradeHandler.UpgradeEvent UPGRADE_SUCCESSFUL The Upgrade to the new protocol was successful.

Constructor Detail

UpgradeEvent	back to summary
private UpgradeEvent()

Method Detail

valueOf	back to summary
public static HttpClientUpgradeHandler.UpgradeEvent valueOf(String name)

values	back to summary
public static HttpClientUpgradeHandler.UpgradeEvent[] values()