io.netty.handler.codec.haproxy

Class HAProxyMessage

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.handler.codec.haproxy.HAProxyMessage

All Implemented Interfaces:

ReferenceCounted

public final class HAProxyMessage
extends AbstractReferenceCounted

Message container for decoded HAProxy proxy protocol parameters

Constructor Summary

Constructors

Constructor and Description
HAProxyMessage(HAProxyProtocolVersion protocolVersion, HAProxyCommand command, HAProxyProxiedProtocol proxiedProtocol, String sourceAddress, String destinationAddress, int sourcePort, int destinationPort) Creates a new instance of HAProxyMessage.
HAProxyMessage(HAProxyProtocolVersion protocolVersion, HAProxyCommand command, HAProxyProxiedProtocol proxiedProtocol, String sourceAddress, String destinationAddress, int sourcePort, int destinationPort, List<? extends HAProxyTLV> tlvs) Creates a new instance of HAProxyMessage.

Method Summary

Modifier and Type	Method and Description
HAProxyCommand	command() Returns the HAProxyCommand of this HAProxyMessage.
protected void	deallocate() Called once AbstractReferenceCounted.refCnt() is equals 0.
String	destinationAddress() Returns the human-readable destination address of this HAProxyMessage.
int	destinationPort() Returns the UDP/TCP destination port of this HAProxyMessage.
HAProxyProtocolVersion	protocolVersion() Returns the HAProxyProtocolVersion of this HAProxyMessage.
HAProxyProxiedProtocol	proxiedProtocol() Returns the HAProxyProxiedProtocol of this HAProxyMessage.
boolean	release() Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement) Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
HAProxyMessage	retain() Increases the reference count by 1.
HAProxyMessage	retain(int increment) Increases the reference count by the specified increment.
String	sourceAddress() Returns the human-readable source address of this HAProxyMessage or null if HAProxy performs health check with send-proxy-v2.
int	sourcePort() Returns the UDP/TCP source port of this HAProxyMessage.
List<HAProxyTLV>	tlvs() Returns a list of HAProxyTLV or an empty list if no TLVs are present.
String	toString()
HAProxyMessage	touch() Records the current access location of this object for debugging purposes.
HAProxyMessage	touch(Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class io.netty.util.AbstractReferenceCounted

refCnt, setRefCnt

Methods inherited from class java.lang.Object

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

Constructor Detail

HAProxyMessage

public HAProxyMessage(HAProxyProtocolVersion protocolVersion,
                      HAProxyCommand command,
                      HAProxyProxiedProtocol proxiedProtocol,
                      String sourceAddress,
                      String destinationAddress,
                      int sourcePort,
                      int destinationPort)

Creates a new instance of HAProxyMessage.

Parameters:

protocolVersion - the protocol version.

command - the command.

proxiedProtocol - the protocol containing the address family and transport protocol.

sourceAddress - the source address.

destinationAddress - the destination address.

sourcePort - the source port. This value must be 0 for unix, unspec addresses.

destinationPort - the destination port. This value must be 0 for unix, unspec addresses.

HAProxyMessage

public HAProxyMessage(HAProxyProtocolVersion protocolVersion,
                      HAProxyCommand command,
                      HAProxyProxiedProtocol proxiedProtocol,
                      String sourceAddress,
                      String destinationAddress,
                      int sourcePort,
                      int destinationPort,
                      List<? extends HAProxyTLV> tlvs)

Creates a new instance of HAProxyMessage.

Parameters:

protocolVersion - the protocol version.

command - the command.

proxiedProtocol - the protocol containing the address family and transport protocol.

sourceAddress - the source address.

destinationAddress - the destination address.

sourcePort - the source port. This value must be 0 for unix, unspec addresses.

destinationPort - the destination port. This value must be 0 for unix, unspec addresses.

tlvs - the list of tlvs.

Method Detail

protocolVersion

public HAProxyProtocolVersion protocolVersion()

Returns the HAProxyProtocolVersion of this HAProxyMessage.

command

public HAProxyCommand command()

Returns the HAProxyCommand of this HAProxyMessage.

proxiedProtocol

public HAProxyProxiedProtocol proxiedProtocol()

Returns the HAProxyProxiedProtocol of this HAProxyMessage.

sourceAddress

public String sourceAddress()

Returns the human-readable source address of this HAProxyMessage or null if HAProxy performs health check with send-proxy-v2.

destinationAddress

public String destinationAddress()

Returns the human-readable destination address of this HAProxyMessage.

sourcePort

public int sourcePort()

Returns the UDP/TCP source port of this HAProxyMessage.

destinationPort

public int destinationPort()

Returns the UDP/TCP destination port of this HAProxyMessage.

tlvs

public List<HAProxyTLV> tlvs()

Returns a list of HAProxyTLV or an empty list if no TLVs are present.

TLVs are only available for the Proxy Protocol V2

touch

public HAProxyMessage touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractReferenceCounted

touch

public HAProxyMessage touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

retain

public HAProxyMessage retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

retain

public HAProxyMessage retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

release

public boolean release()

Description copied from interface: ReferenceCounted

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Overrides:

release in class AbstractReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

release

public boolean release(int decrement)

Description copied from interface: ReferenceCounted

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Overrides:

release in class AbstractReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

deallocate

protected void deallocate()

Description copied from class: AbstractReferenceCounted

Called once AbstractReferenceCounted.refCnt() is equals 0.

Specified by:

deallocate in class AbstractReferenceCounted

toString

public String toString()

Overrides:

toString in class Object