Class HAProxyMessageEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToByteEncoder<HAProxyMessage>

io.netty.handler.codec.haproxy.HAProxyMessageEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

@Sharable
public final class HAProxyMessageEncoder
extends MessageToByteEncoder<HAProxyMessage>

Encodes an HAProxy proxy protocol message

See Also:

• Proxy Protocol Specification

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
static final HAProxyMessageEncoder	INSTANCE
(package private) static final int	TOTAL_UNIX_ADDRESS_BYTES_LENGTH
(package private) static final int	UNIX_ADDRESS_BYTES_LENGTH
private static final int	V2_VERSION_BITMASK

Constructor Summary

Constructors

Modifier	Constructor	Description
private	HAProxyMessageEncoder()

Method Summary

Modifier and Type	Method	Description
protected void	encode(ChannelHandlerContext ctx, HAProxyMessage msg, ByteBuf out)	Encode a message into a ByteBuf.
private static void	encodeChildTlvs(List<HAProxyTLV> haProxyTLVs, ByteBuf out)	Encodes a genuine tree of encapsulated TLVs, e.g.
private static void	encodeTlv(HAProxyTLV haProxyTLV, ByteBuf out)
private static void	encodeTlvs(List<HAProxyTLV> haProxyTLVs, ByteBuf out)	Encodes the top-level TLV list as returned by HAProxyMessage.tlvs().
private static void	encodeV1(HAProxyMessage msg, ByteBuf out)
private static void	encodeV2(HAProxyMessage msg, ByteBuf out)

Methods inherited from class MessageToByteEncoder

acceptOutboundMessage, allocateBuffer, isPreferDirect, write

Methods inherited from class ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class Object

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

Methods inherited from interface ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Field Details

V2_VERSION_BITMASK

private static final int V2_VERSION_BITMASK

See Also:

• Constant Field Values

UNIX_ADDRESS_BYTES_LENGTH

static final int UNIX_ADDRESS_BYTES_LENGTH

See Also:

• Constant Field Values

TOTAL_UNIX_ADDRESS_BYTES_LENGTH

static final int TOTAL_UNIX_ADDRESS_BYTES_LENGTH

See Also:

• Constant Field Values

INSTANCE

public static final HAProxyMessageEncoder INSTANCE

Constructor Details

HAProxyMessageEncoder

private HAProxyMessageEncoder()

Method Details

encode

protected void encode(ChannelHandlerContext ctx,
 HAProxyMessage msg,
 ByteBuf out)
               throws Exception

Description copied from class: MessageToByteEncoder

Encode a message into a ByteBuf. This method will be called for each written message that can be handled by this encoder.

Specified by:

encode in class MessageToByteEncoder<HAProxyMessage>

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

msg - the message to encode

out - the ByteBuf into which the encoded message will be written

Throws:

Exception - is thrown if an error occurs

encodeV1

private static void encodeV1(HAProxyMessage msg,
 ByteBuf out)

encodeV2

private static void encodeV2(HAProxyMessage msg,
 ByteBuf out)

encodeTlv

private static void encodeTlv(HAProxyTLV haProxyTLV,
 ByteBuf out)

encodeChildTlvs

private static void encodeChildTlvs(List<HAProxyTLV> haProxyTLVs,
 ByteBuf out)

Encodes a genuine tree of encapsulated TLVs, e.g. the direct children of a HAProxySSLTLV. Unlike HAProxyMessage.tlvs(), this list is not a flattened view, so every element must be encoded.

encodeTlvs

private static void encodeTlvs(List<HAProxyTLV> haProxyTLVs,
 ByteBuf out)

Encodes the top-level TLV list as returned by HAProxyMessage.tlvs(). That list flattens the direct children of any HAProxySSLTLV into it for convenience, so those flattened entries must be skipped here: they are already encoded (recursively) as part of their parent HAProxySSLTLV. Encoding them again would both duplicate their bytes on the wire and make the declared TLV length (see HAProxyMessage.tlvNumBytes()) not match the number of bytes actually written.