io.netty.handler.codec.http

Class HttpClientCodec

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.channel.CombinedChannelDuplexHandler<HttpResponseDecoder,HttpRequestEncoder>

io.netty.handler.codec.http.HttpClientCodec

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler, HttpClientUpgradeHandler.SourceCodec

public final class HttpClientCodec
extends CombinedChannelDuplexHandler<HttpResponseDecoder,HttpRequestEncoder>
implements HttpClientUpgradeHandler.SourceCodec

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.

See Also:

HttpServerCodec

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	isSingleDecode()
void	prepareUpgradeFrom(ChannelHandlerContext ctx) Prepares to upgrade to another protocol from HTTP.
void	setSingleDecode(boolean singleDecode)
void	upgradeFrom(ChannelHandlerContext ctx) Upgrades to another protocol from HTTP.

Methods inherited from class io.netty.channel.CombinedChannelDuplexHandler

bind, channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, handlerAdded, handlerRemoved, inboundHandler, init, outboundHandler, read, removeInboundHandler, removeOutboundHandler, userEventTriggered, write

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClientCodec

public HttpClientCodec()

Creates a new instance with the default decoder options (maxInitialLineLength (4096}, maxHeaderSize (8192), and maxChunkSize (8192)).

HttpClientCodec

public HttpClientCodec(int maxInitialLineLength,
                       int maxHeaderSize,
                       int maxChunkSize)

Creates a new instance with the specified decoder options.

HttpClientCodec

public HttpClientCodec(int maxInitialLineLength,
                       int maxHeaderSize,
                       int maxChunkSize,
                       boolean failOnMissingResponse)

Creates a new instance with the specified decoder options.

HttpClientCodec

public HttpClientCodec(int maxInitialLineLength,
                       int maxHeaderSize,
                       int maxChunkSize,
                       boolean failOnMissingResponse,
                       boolean validateHeaders)

Creates a new instance with the specified decoder options.

HttpClientCodec

public HttpClientCodec(int maxInitialLineLength,
                       int maxHeaderSize,
                       int maxChunkSize,
                       boolean failOnMissingResponse,
                       boolean validateHeaders,
                       boolean parseHttpAfterConnectRequest)

Creates a new instance with the specified decoder options.

HttpClientCodec

public HttpClientCodec(int maxInitialLineLength,
                       int maxHeaderSize,
                       int maxChunkSize,
                       boolean failOnMissingResponse,
                       boolean validateHeaders,
                       int initialBufferSize)

Creates a new instance with the specified decoder options.

HttpClientCodec

public HttpClientCodec(int maxInitialLineLength,
                       int maxHeaderSize,
                       int maxChunkSize,
                       boolean failOnMissingResponse,
                       boolean validateHeaders,
                       int initialBufferSize,
                       boolean parseHttpAfterConnectRequest)

Creates a new instance with the specified decoder options.

Method Detail

prepareUpgradeFrom

public void prepareUpgradeFrom(ChannelHandlerContext ctx)

Prepares to upgrade to another protocol from HTTP. Disables the Encoder.

Specified by:

prepareUpgradeFrom in interface HttpClientUpgradeHandler.SourceCodec

upgradeFrom

public void upgradeFrom(ChannelHandlerContext ctx)

Upgrades to another protocol from HTTP. Removes the Decoder and Encoder from the pipeline.

Specified by:

upgradeFrom in interface HttpClientUpgradeHandler.SourceCodec

setSingleDecode

public void setSingleDecode(boolean singleDecode)

isSingleDecode

public boolean isSingleDecode()