Top Description Inners Fields Constructors Methods
io.netty.handler.codec.haproxy

public final Enum HAProxyProxiedProtocol

extends Enum<HAProxyProxiedProtocol>
Class Inheritance
Static Imports
io.netty.handler.codec.haproxy.HAProxyConstants.*

A protocol proxied by HAProxy which is represented by its transport protocol and address family.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
HAProxyProxiedProtocol.AddressFamily

The address family of an HAProxy proxy protocol header.

public static enum
HAProxyProxiedProtocol.TransportProtocol

The transport protocol of an HAProxy proxy protocol header

Field Summary

Modifier and TypeField and Description
private final HAProxyProxiedProtocol.AddressFamily
private final byte
public static final HAProxyProxiedProtocol
TCP4

The TCP4 represents a connection which was forwarded for an IPv4 client over TCP.

public static final HAProxyProxiedProtocol
TCP6

The TCP6 represents a connection which was forwarded for an IPv6 client over TCP.

private final HAProxyProxiedProtocol.TransportProtocol
public static final HAProxyProxiedProtocol
UDP4

The UDP4 represents a connection which was forwarded for an IPv4 client over UDP.

public static final HAProxyProxiedProtocol
UDP6

The UDP6 represents a connection which was forwarded for an IPv6 client over UDP.

public static final HAProxyProxiedProtocol
UNIX_DGRAM

The UNIX_DGRAM represents a connection which was forwarded for a UNIX datagram socket.

public static final HAProxyProxiedProtocol
UNIX_STREAM

The UNIX_STREAM represents a connection which was forwarded for a UNIX stream socket.

public static final HAProxyProxiedProtocol
UNKNOWN

The UNKNOWN represents a connection which was forwarded for an unknown protocol and an unknown address family.

Constructor Summary

AccessConstructor and Description
private
HAProxyProxiedProtocol(byte byteValue, HAProxyProxiedProtocol.AddressFamily addressFamily, HAProxyProxiedProtocol.TransportProtocol transportProtocol)

Creates a new instance.

Method Summary

Modifier and TypeMethod and Description
public HAProxyProxiedProtocol.AddressFamily
addressFamily()

Returns the AddressFamily of this protocol and address family.

public byte
byteValue()

Returns the byte value of this protocol and address family.

public HAProxyProxiedProtocol.TransportProtocol
transportProtocol()

Returns the TransportProtocol of this protocol and address family.

public static HAProxyProxiedProtocol
public static HAProxyProxiedProtocol
valueOf(byte
transport protocol and address family byte
tpafByte
)

Returns the HAProxyProxiedProtocol represented by the specified byte.

public static HAProxyProxiedProtocol[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

addressFamilyback to summary
private final HAProxyProxiedProtocol.AddressFamily addressFamily
byteValueback to summary
private final byte byteValue
TCP4back to summary
public static final HAProxyProxiedProtocol TCP4

The TCP4 represents a connection which was forwarded for an IPv4 client over TCP.

TCP6back to summary
public static final HAProxyProxiedProtocol TCP6

The TCP6 represents a connection which was forwarded for an IPv6 client over TCP.

transportProtocolback to summary
private final HAProxyProxiedProtocol.TransportProtocol transportProtocol
UDP4back to summary
public static final HAProxyProxiedProtocol UDP4

The UDP4 represents a connection which was forwarded for an IPv4 client over UDP.

UDP6back to summary
public static final HAProxyProxiedProtocol UDP6

The UDP6 represents a connection which was forwarded for an IPv6 client over UDP.

UNIX_DGRAMback to summary
public static final HAProxyProxiedProtocol UNIX_DGRAM

The UNIX_DGRAM represents a connection which was forwarded for a UNIX datagram socket.

UNIX_STREAMback to summary
public static final HAProxyProxiedProtocol UNIX_STREAM

The UNIX_STREAM represents a connection which was forwarded for a UNIX stream socket.

UNKNOWNback to summary
public static final HAProxyProxiedProtocol UNKNOWN

The UNKNOWN represents a connection which was forwarded for an unknown protocol and an unknown address family.

Constructor Detail

HAProxyProxiedProtocolback to summary
private HAProxyProxiedProtocol(byte byteValue, HAProxyProxiedProtocol.AddressFamily addressFamily, HAProxyProxiedProtocol.TransportProtocol transportProtocol)

Creates a new instance.

Method Detail

addressFamilyback to summary
public HAProxyProxiedProtocol.AddressFamily addressFamily()

Returns the AddressFamily of this protocol and address family.

byteValueback to summary
public byte byteValue()

Returns the byte value of this protocol and address family.

transportProtocolback to summary
public HAProxyProxiedProtocol.TransportProtocol transportProtocol()

Returns the TransportProtocol of this protocol and address family.

valueOfback to summary
public static HAProxyProxiedProtocol valueOf(String name)
valueOfback to summary
public static HAProxyProxiedProtocol valueOf(byte tpafByte)

Returns the HAProxyProxiedProtocol represented by the specified byte.

Parameters
tpafByte:byte

transport protocol and address family byte

valuesback to summary
public static HAProxyProxiedProtocol[] values()
io.netty.handler.codec.haproxy back to summary

public final Enum HAProxyProxiedProtocol.AddressFamily

extends Enum<HAProxyProxiedProtocol.AddressFamily>
Class Inheritance

The address family of an HAProxy proxy protocol header.

Field Summary

Modifier and TypeField and Description
public static final HAProxyProxiedProtocol.AddressFamily
AF_IPv4

The IPV4 address family represents a connection which was forwarded for an IPV4 client.

public static final HAProxyProxiedProtocol.AddressFamily
AF_IPv6

The IPV6 address family represents a connection which was forwarded for an IPV6 client.

public static final HAProxyProxiedProtocol.AddressFamily
AF_UNIX

The UNIX address family represents a connection which was forwarded for a unix socket.

public static final HAProxyProxiedProtocol.AddressFamily
AF_UNSPEC

The UNSPECIFIED address family represents a connection which was forwarded for an unknown protocol.

private final byte
private static final byte
FAMILY_MASK

The highest 4 bits of the transport protocol and address family byte contain the address family

Constructor Summary

AccessConstructor and Description
private
AddressFamily(byte byteValue)

Creates a new instance

Method Summary

Modifier and TypeMethod and Description
public byte
byteValue()

Returns the byte value of this address family.

public static HAProxyProxiedProtocol.AddressFamily
public static HAProxyProxiedProtocol.AddressFamily
valueOf(byte
transport protocol and address family byte
tpafByte
)

Returns the AddressFamily represented by the highest 4 bits of the specified byte.

public static HAProxyProxiedProtocol.AddressFamily[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

AF_IPv4back to summary
public static final HAProxyProxiedProtocol.AddressFamily AF_IPv4

The IPV4 address family represents a connection which was forwarded for an IPV4 client.

AF_IPv6back to summary
public static final HAProxyProxiedProtocol.AddressFamily AF_IPv6

The IPV6 address family represents a connection which was forwarded for an IPV6 client.

AF_UNIXback to summary
public static final HAProxyProxiedProtocol.AddressFamily AF_UNIX

The UNIX address family represents a connection which was forwarded for a unix socket.

AF_UNSPECback to summary
public static final HAProxyProxiedProtocol.AddressFamily AF_UNSPEC

The UNSPECIFIED address family represents a connection which was forwarded for an unknown protocol.

byteValueback to summary
private final byte byteValue
FAMILY_MASKback to summary
private static final byte FAMILY_MASK

The highest 4 bits of the transport protocol and address family byte contain the address family

Constructor Detail

AddressFamilyback to summary
private AddressFamily(byte byteValue)

Creates a new instance

Method Detail

byteValueback to summary
public byte byteValue()

Returns the byte value of this address family.

valueOfback to summary
public static HAProxyProxiedProtocol.AddressFamily valueOf(String name)
valueOfback to summary
public static HAProxyProxiedProtocol.AddressFamily valueOf(byte tpafByte)

Returns the AddressFamily represented by the highest 4 bits of the specified byte.

Parameters
tpafByte:byte

transport protocol and address family byte

valuesback to summary
public static HAProxyProxiedProtocol.AddressFamily[] values()
io.netty.handler.codec.haproxy back to summary

public final Enum HAProxyProxiedProtocol.TransportProtocol

extends Enum<HAProxyProxiedProtocol.TransportProtocol>
Class Inheritance

The transport protocol of an HAProxy proxy protocol header

Field Summary

Modifier and TypeField and Description
public static final HAProxyProxiedProtocol.TransportProtocol
DGRAM

The DGRAM transport protocol represents a connection which was forwarded for a UDP connection.

public static final HAProxyProxiedProtocol.TransportProtocol
STREAM

The STREAM transport protocol represents a connection which was forwarded for a TCP connection.

private static final byte
TRANSPORT_MASK

The transport protocol is specified in the lowest 4 bits of the transport protocol and address family byte

private final byte
public static final HAProxyProxiedProtocol.TransportProtocol
UNSPEC

The UNSPEC transport protocol represents a connection which was forwarded for an unknown protocol.

Constructor Summary

AccessConstructor and Description
private
TransportProtocol(byte transportByte)

Creates a new instance.

Method Summary

Modifier and TypeMethod and Description
public byte
byteValue()

Returns the byte value of this transport protocol.

public static HAProxyProxiedProtocol.TransportProtocol
public static HAProxyProxiedProtocol.TransportProtocol
valueOf(byte
transport protocol and address family byte
tpafByte
)

Returns the TransportProtocol represented by the lowest 4 bits of the specified byte.

public static HAProxyProxiedProtocol.TransportProtocol[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

DGRAMback to summary
public static final HAProxyProxiedProtocol.TransportProtocol DGRAM

The DGRAM transport protocol represents a connection which was forwarded for a UDP connection.

STREAMback to summary
public static final HAProxyProxiedProtocol.TransportProtocol STREAM

The STREAM transport protocol represents a connection which was forwarded for a TCP connection.

TRANSPORT_MASKback to summary
private static final byte TRANSPORT_MASK

The transport protocol is specified in the lowest 4 bits of the transport protocol and address family byte

transportByteback to summary
private final byte transportByte
UNSPECback to summary
public static final HAProxyProxiedProtocol.TransportProtocol UNSPEC

The UNSPEC transport protocol represents a connection which was forwarded for an unknown protocol.

Constructor Detail

TransportProtocolback to summary
private TransportProtocol(byte transportByte)

Creates a new instance.

Method Detail

byteValueback to summary
public byte byteValue()

Returns the byte value of this transport protocol.

valueOfback to summary
public static HAProxyProxiedProtocol.TransportProtocol valueOf(String name)
valueOfback to summary
public static HAProxyProxiedProtocol.TransportProtocol valueOf(byte tpafByte)

Returns the TransportProtocol represented by the lowest 4 bits of the specified byte.

Parameters
tpafByte:byte

transport protocol and address family byte

valuesback to summary
public static HAProxyProxiedProtocol.TransportProtocol[] values()