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

public final class HttpClientCodec
extends CombinedChannelDuplexHandler<HttpResponseDecoder,HttpRequestEncoder>

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

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

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

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	done If true, decoding stops (i.e.
private boolean	failOnMissingResponse
private java.util.Queue<HttpMethod>	queue A queue that is used for correlating a request and a response.
private java.util.concurrent.atomic.AtomicLong	requestResponseCounter

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, int initialBufferSize) Creates a new instance with the specified decoder options.

Method Summary

Modifier and Type	Method and Description
boolean	isSingleDecode()
void	setSingleDecode(boolean singleDecode)

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

isSharable

Methods inherited from class java.lang.Object

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

Field Detail

queue

private final java.util.Queue<HttpMethod> queue

A queue that is used for correlating a request and a response.

done

private boolean done

If true, decoding stops (i.e. pass-through)

requestResponseCounter

private final java.util.concurrent.atomic.AtomicLong requestResponseCounter

failOnMissingResponse

private final boolean failOnMissingResponse

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,
                       int initialBufferSize)

Creates a new instance with the specified decoder options.

Method Detail

setSingleDecode

public void setSingleDecode(boolean singleDecode)

isSingleDecode

public boolean isSingleDecode()