Class HAProxyMessageDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.haproxy.HAProxyMessageDecoder

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class HAProxyMessageDecoder
extends ByteToMessageDecoder

Decodes an HAProxy proxy protocol header

See Also:

• Proxy Protocol Specification

Nested Class Summary

Nested classes/interfaces inherited from class ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields inherited from class ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor	Description
HAProxyMessageDecoder()	Creates a new decoder with no additional data (TLV) restrictions, and should throw an exception as soon as we exceed maxLength.
HAProxyMessageDecoder(boolean failFast)	Creates a new decoder with no additional data (TLV) restrictions, whether or not to throw an exception as soon as we exceed maxLength.
HAProxyMessageDecoder(int maxTlvSize)	Creates a new decoder with restricted additional data (TLV) size, and should throw an exception as soon as we exceed maxLength.
HAProxyMessageDecoder(int maxTlvSize, boolean failFast)	Creates a new decoder with restricted additional data (TLV) size, whether or not to throw an exception as soon as we exceed maxLength.

Method Summary

Modifier and Type	Method	Description
void	channelRead(ChannelHandlerContext ctx, Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected final void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)	Decode the from one ByteBuf to an other.
static ProtocolDetectionResult<HAProxyProtocolVersion>	detectProtocol(ByteBuf buffer)	Returns the ProtocolDetectionResult for the given ByteBuf.
boolean	isSingleDecode()	If true then only one message is decoded on each ByteToMessageDecoder.channelRead(ChannelHandlerContext, Object) call.

Methods inherited from class ByteToMessageDecoder

actualReadableBytes, callDecode, channelInactive, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class Object

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

Methods inherited from interface ChannelHandler

handlerAdded

Constructor Details

HAProxyMessageDecoder

public HAProxyMessageDecoder()

Creates a new decoder with no additional data (TLV) restrictions, and should throw an exception as soon as we exceed maxLength.

HAProxyMessageDecoder

public HAProxyMessageDecoder(boolean failFast)

Creates a new decoder with no additional data (TLV) restrictions, whether or not to throw an exception as soon as we exceed maxLength.

Parameters:

failFast - Whether or not to throw an exception as soon as we exceed maxLength

HAProxyMessageDecoder

public HAProxyMessageDecoder(int maxTlvSize)

Creates a new decoder with restricted additional data (TLV) size, and should throw an exception as soon as we exceed maxLength.

Note: limiting TLV size only affects processing of v2, binary headers. Also, as allowed by the 1.5 spec TLV data is currently ignored. For maximum performance it would be best to configure your upstream proxy host to NOT send TLV data and instantiate with a max TLV size of 0.

Parameters:

maxTlvSize - maximum number of bytes allowed for additional data (Type-Length-Value vectors) in a v2 header

HAProxyMessageDecoder

public HAProxyMessageDecoder(int maxTlvSize,
 boolean failFast)

Creates a new decoder with restricted additional data (TLV) size, whether or not to throw an exception as soon as we exceed maxLength.

Parameters:

maxTlvSize - maximum number of bytes allowed for additional data (Type-Length-Value vectors) in a v2 header

failFast - Whether or not to throw an exception as soon as we exceed maxLength

Method Details

isSingleDecode

public boolean isSingleDecode()

Description copied from class: ByteToMessageDecoder

If true then only one message is decoded on each ByteToMessageDecoder.channelRead(ChannelHandlerContext, Object) call. Default is false as this has performance impacts.

Overrides:

isSingleDecode in class ByteToMessageDecoder

channelRead

public void channelRead(ChannelHandlerContext ctx,
 Object msg)
                 throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelRead in interface ChannelInboundHandler

Overrides:

channelRead in class ByteToMessageDecoder

Throws:

Exception

decode

protected final void decode(ChannelHandlerContext ctx,
 ByteBuf in,
 List<Object> out)
                     throws Exception

Description copied from class: ByteToMessageDecoder

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

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs

detectProtocol

public static ProtocolDetectionResult<HAProxyProtocolVersion> detectProtocol(ByteBuf buffer)

Returns the ProtocolDetectionResult for the given ByteBuf.