io.netty.handler.codec.haproxy

类 HAProxyMessageDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.haproxy.HAProxyMessageDecoder

所有已实现的接口:

ChannelHandler, ChannelInboundHandler

public class HAProxyMessageDecoder
extends ByteToMessageDecoder

Decodes an HAProxy proxy protocol header

另请参阅:

Proxy Protocol Specification

嵌套类概要

从类继承的嵌套类/接口 io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

字段概要

从类继承的字段 io.netty.handler.codec.ByteToMessageDecoder

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造器概要

构造器

构造器和说明
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.

方法概要

限定符和类型	方法和说明
void	channelRead(ChannelHandlerContext ctx, java.lang.Object msg) Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.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.

从类继承的方法 io.netty.handler.codec.ByteToMessageDecoder

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

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

从类继承的方法 java.lang.Object

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

从接口继承的方法 io.netty.channel.ChannelHandler

handlerAdded

构造器详细资料

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.

参数:

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.

参数:

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.

参数:

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

方法详细资料

isSingleDecode

public boolean isSingleDecode()

从类复制的说明: ByteToMessageDecoder

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

覆盖:

isSingleDecode 在类中 ByteToMessageDecoder

channelRead

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

从类复制的说明: ChannelInboundHandlerAdapter

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

指定者:

channelRead 在接口中 ChannelInboundHandler

覆盖:

channelRead 在类中 ByteToMessageDecoder

抛出:

java.lang.Exception

decode

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

从类复制的说明: 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.

指定者:

decode 在类中 ByteToMessageDecoder

参数:

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

抛出:

java.lang.Exception - is thrown if an error occurs

detectProtocol

public static ProtocolDetectionResult<HAProxyProtocolVersion> detectProtocol(ByteBuf buffer)

Returns the ProtocolDetectionResult for the given ByteBuf.