A combination of HttpRequestEncoder and HttpResponseDecoder which enables easier client side HTTP implementation. HttpClientCodec provides additional state management for HEAD and CONNECT requests, which HttpResponseDecoder lacks. Please refer to HttpResponseDecoder to learn what additional state management needs to be done for HEAD and CONNECT and why HttpResponseDecoder can not handle it by itself. If the Channel is closed and there are missing responses, a PrematureChannelClosureException is thrown.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	HttpClientCodec.Decoder
private class	HttpClientCodec.Encoder

Field Summary

Modifier and Type	Field and Description
public static final boolean	DEFAULT_FAIL_ON_MISSING_RESPONSE
public static final boolean	DEFAULT_PARSE_HTTP_AFTER_CONNECT_REQUEST
private boolean	done If true, decoding stops (i.e. pass-through)
private final boolean	failOnMissingResponse
private final boolean	parseHttpAfterConnectRequest
private final Queue<HttpMethod>	queue A queue that is used for correlating a request and a response.
private final AtomicLong	requestResponseCounter

Constructor Summary

Access	Constructor and Description
public	HttpClientCodec() Creates a new instance with the default decoder options (`maxInitialLineLength (4096`}, `maxHeaderSize (8192)`, and `maxChunkSize (8192)`).
public	HttpClientCodec(int maxInitialLineLength, int maxHeaderSize) Creates a new instance with the specified decoder options.
public	HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse) Creates a new instance with the specified decoder options.
public	HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse, boolean validateHeaders) Creates a new instance with the specified decoder options.
public	HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse, boolean validateHeaders, boolean parseHttpAfterConnectRequest) Creates a new instance with the specified decoder options.
public	HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse, boolean validateHeaders, int initialBufferSize) Creates a new instance with the specified decoder options.
public	HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse, boolean validateHeaders, int initialBufferSize, boolean parseHttpAfterConnectRequest) Creates a new instance with the specified decoder options.
public	HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse, boolean validateHeaders, int initialBufferSize, boolean parseHttpAfterConnectRequest, boolean allowDuplicateContentLengths) Creates a new instance with the specified decoder options.

Modifier and Type	Method and Description
public boolean	isSingleDecode()
public void	prepareUpgradeFrom(ChannelHandlerContext ctx) Implements io.netty5.handler.codec.http.HttpClientUpgradeHandler.SourceCodec.prepareUpgradeFrom. Prepares to upgrade to another protocol from HTTP.
public void	setSingleDecode(boolean singleDecode)
public void	upgradeFrom(ChannelHandlerContext ctx) Implements io.netty5.handler.codec.http.HttpClientUpgradeHandler.SourceCodec.upgradeFrom. Upgrades to another protocol from HTTP.

Field Detail

DEFAULT_FAIL_ON_MISSING_RESPONSE	back to summary
public static final boolean DEFAULT_FAIL_ON_MISSING_RESPONSE

DEFAULT_PARSE_HTTP_AFTER_CONNECT_REQUEST	back to summary
public static final boolean DEFAULT_PARSE_HTTP_AFTER_CONNECT_REQUEST

done	back to summary
private boolean done If true, decoding stops (i.e. pass-through)

failOnMissingResponse	back to summary
private final boolean failOnMissingResponse

parseHttpAfterConnectRequest	back to summary
private final boolean parseHttpAfterConnectRequest

queue	back to summary
private final Queue<HttpMethod> queue A queue that is used for correlating a request and a response.

requestResponseCounter	back to summary
private final AtomicLong requestResponseCounter

Constructor Detail

HttpClientCodec	back to summary
public HttpClientCodec() Creates a new instance with the default decoder options (`maxInitialLineLength (4096`}, `maxHeaderSize (8192)`, and `maxChunkSize (8192)`).

HttpClientCodec	back to summary
public HttpClientCodec(int maxInitialLineLength, int maxHeaderSize) Creates a new instance with the specified decoder options.

HttpClientCodec	back to summary
public HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse) Creates a new instance with the specified decoder options.

HttpClientCodec	back to summary
public HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse, boolean validateHeaders) Creates a new instance with the specified decoder options.

HttpClientCodec	back to summary
public HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse, boolean validateHeaders, boolean parseHttpAfterConnectRequest) Creates a new instance with the specified decoder options.

HttpClientCodec	back to summary
public HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse, boolean validateHeaders, int initialBufferSize) Creates a new instance with the specified decoder options.

HttpClientCodec	back to summary
public HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse, boolean validateHeaders, int initialBufferSize, boolean parseHttpAfterConnectRequest) Creates a new instance with the specified decoder options.

HttpClientCodec	back to summary
public HttpClientCodec(int maxInitialLineLength, int maxHeaderSize, boolean failOnMissingResponse, boolean validateHeaders, int initialBufferSize, boolean parseHttpAfterConnectRequest, boolean allowDuplicateContentLengths) Creates a new instance with the specified decoder options.

isSingleDecode	back to summary
public boolean isSingleDecode()

prepareUpgradeFrom	back to summary
public void prepareUpgradeFrom(ChannelHandlerContext ctx) Implements io.netty5.handler.codec.http.HttpClientUpgradeHandler.SourceCodec.prepareUpgradeFrom. Prepares to upgrade to another protocol from HTTP. Disables the `Encoder`. Annotations @Override

setSingleDecode	back to summary
public void setSingleDecode(boolean singleDecode)

upgradeFrom	back to summary
public void upgradeFrom(ChannelHandlerContext ctx) Implements io.netty5.handler.codec.http.HttpClientUpgradeHandler.SourceCodec.upgradeFrom. Upgrades to another protocol from HTTP. Removes the `Decoder` and `Encoder` from the pipeline. Annotations @Override

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

private final Class HttpClientCodec.Decoder

Class Inheritance

extends HttpResponseDecoder

java.lang.Object
io.netty5.channel.ChannelHandlerAdapter
io.netty5.handler.codec.ByteToMessageDecoder
io.netty5.handler.codec.http.HttpObjectDecoder
io.netty5.handler.codec.http.HttpResponseDecoder
io.netty5.handler.codec.http.HttpClientCodec.Decoder

Field Summary

Modifier and Type	Field and Description
private ChannelHandlerContext	context Hides io.netty5.handler.codec.ByteToMessageDecoder.context.

Constructor Summary

Access	Constructor and Description
pack-priv	Decoder(int maxInitialLineLength, int maxHeaderSize, boolean validateHeaders)
pack-priv	Decoder(int maxInitialLineLength, int maxHeaderSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths)

Method Summary

Modifier and Type	Method and Description
public void	channelInactive(ChannelHandlerContext ctx) Overrides io.netty5.handler.codec.ByteToMessageDecoder.channelInactive. Overrides default io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime.
protected void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to ctx, Buffer the `Buffer` from which to read data buffer) Overrides io.netty5.handler.codec.http.HttpObjectDecoder.decode. Decode the from one `Buffer` to another.
private void	decrement(Object msg)
protected void	handlerAdded0(ChannelHandlerContext ctx) Overrides io.netty5.handler.codec.ByteToMessageDecoder.handlerAdded0.
protected boolean	isContentAlwaysEmpty(HttpMessage msg) Overrides io.netty5.handler.codec.http.HttpObjectDecoder.isContentAlwaysEmpty.

Inherited from io.netty5.handler.codec.http.HttpResponseDecoder:: createInvalidMessage createMessage isDecodingRequest

Field Detail

context	back to summary
private ChannelHandlerContext context Hides io.netty5.handler.codec.ByteToMessageDecoder.context.

Constructor Detail

Decoder	back to summary
pack-priv Decoder(int maxInitialLineLength, int maxHeaderSize, boolean validateHeaders)

Decoder	back to summary
pack-priv Decoder(int maxInitialLineLength, int maxHeaderSize, boolean validateHeaders, int initialBufferSize, boolean allowDuplicateContentLengths)

Method Detail

channelInactive back to summary

channelInactive	back to summary
public void channelInactive(ChannelHandlerContext ctx) throws Exception Overrides io.netty5.handler.codec.ByteToMessageDecoder.channelInactive. Overrides default io.netty5.channel.ChannelHandler.channelInactive. Doc from io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime. Annotations @Override

public void channelInactive(ChannelHandlerContext ctx) throws Exception

Overrides io.netty5.handler.codec.ByteToMessageDecoder.channelInactive.

Overrides default io.netty5.channel.ChannelHandler.channelInactive.

Doc from io.netty5.channel.ChannelHandler.channelInactive.

The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.

Annotations

@Override

decode back to summary

decode	back to summary
protected void decode(ChannelHandlerContext ctx, Buffer buffer) throws Exception Overrides io.netty5.handler.codec.http.HttpObjectDecoder.decode. Doc from io.netty5.handler.codec.ByteToMessageDecoder.decode. Decode the from one `Buffer` to another. This method will be called till either the input `Buffer` has nothing to read when return from this method or till nothing was read from the input `Buffer`. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `ByteToMessageDecoder` belongs to buffer:Buffer the `Buffer` from which to read data Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decode(ChannelHandlerContext ctx, Buffer buffer) throws Exception

Overrides io.netty5.handler.codec.http.HttpObjectDecoder.decode.

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

Decode the from one Buffer to another. This method will be called till either the input Buffer has nothing to read when return from this method or till nothing was read from the input Buffer.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this ByteToMessageDecoder belongs to
buffer:Buffer: the Buffer from which to read data

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

decrement	back to summary
private void decrement(Object msg)

handlerAdded0	back to summary
protected void handlerAdded0(ChannelHandlerContext ctx) Overrides io.netty5.handler.codec.ByteToMessageDecoder.handlerAdded0. Annotations @Override

handlerAdded0

back to summary

protected void handlerAdded0(ChannelHandlerContext ctx)

Overrides io.netty5.handler.codec.ByteToMessageDecoder.handlerAdded0.

Annotations

@Override

isContentAlwaysEmpty	back to summary
protected boolean isContentAlwaysEmpty(HttpMessage msg) Overrides io.netty5.handler.codec.http.HttpObjectDecoder.isContentAlwaysEmpty. Annotations @Override

isContentAlwaysEmpty

back to summary

protected boolean isContentAlwaysEmpty(HttpMessage msg)

Overrides io.netty5.handler.codec.http.HttpObjectDecoder.isContentAlwaysEmpty.

Annotations

@Override

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

private final Class HttpClientCodec.Encoder

Class Inheritance

extends HttpRequestEncoder

java.lang.Object
io.netty5.channel.ChannelHandlerAdapter
io.netty5.handler.codec.MessageToMessageEncoder
io.netty5.handler.codec.http.HttpObjectEncoder
io.netty5.handler.codec.http.HttpRequestEncoder
io.netty5.handler.codec.http.HttpClientCodec.Encoder

Field Summary

Modifier and Type	Field and Description
pack-priv boolean	upgraded

Constructor Summary

Access	Constructor and Description
private	Encoder()

Method Summary

Modifier and Type	Method and Description
protected void	encodeAndClose(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageEncoder` belongs to. ctx, Object the message to encode to another one. msg, List<Object> the `List` into which produced output messages should be added. out) Overrides io.netty5.handler.codec.http.HttpObjectEncoder.encodeAndClose. Encode from one message to another.

Inherited from io.netty5.handler.codec.http.HttpRequestEncoder:: acceptOutboundMessage encodeInitialLine

Field Detail

upgraded	back to summary
pack-priv boolean upgraded

Constructor Detail

Encoder	back to summary
private Encoder()

Method Detail

encodeAndClose back to summary

encodeAndClose	back to summary
protected void encodeAndClose(ChannelHandlerContext ctx, Object msg, List<Object> out) throws Exception Overrides io.netty5.handler.codec.http.HttpObjectEncoder.encodeAndClose. Doc from io.netty5.handler.codec.MessageToMessageEncoder.encodeAndClose. Encode from one message to another. This method will be called for each written message that can be handled by this encoder. The message will not be automatically disposed of after this call. Instead, the responsibility of ensuring that messages are disposed of falls upon the implementor of this method. Subclasses that wish to have incoming messages automatically disposed of should instead override the `encode(ChannelHandlerContext, Object, List)` method. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageEncoder` belongs to. msg:Object the message to encode to another one. out:List<Object> the `List` into which produced output messages should be added. Annotations @Override Exceptions Exception: is thrown if an error occurs.

protected void encodeAndClose(ChannelHandlerContext ctx, Object msg, List<Object> out) throws Exception

Overrides io.netty5.handler.codec.http.HttpObjectEncoder.encodeAndClose.

Doc from io.netty5.handler.codec.MessageToMessageEncoder.encodeAndClose.

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

The message will not be automatically disposed of after this call. Instead, the responsibility of ensuring that messages are disposed of falls upon the implementor of this method.

Subclasses that wish to have incoming messages automatically disposed of should instead override the encode(ChannelHandlerContext, Object, List) method.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageEncoder belongs to.
msg:Object: the message to encode to another one.
out:List<Object>: the List into which produced output messages should be added.

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs.

public final Class HttpClientCodec

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HttpClientCodec.Decoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HttpClientCodec.Encoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail