Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	HAProxyTLV.Type The registered types a TLV can have regarding the PROXY protocol 1.5 spec

Modifier and Type	Field and Description
private final HAProxyTLV.Type	type
private final byte	typeByteValue

Constructor Summary

Access	Constructor and Description
public	HAProxyTLV(byte the byteValue of the TLV. This is especially important if non-standard TLVs are used typeByteValue, ByteBuf the raw content of the TLV content) Creates a new HAProxyTLV
public	HAProxyTLV(HAProxyTLV.Type the `Type` of the TLV type, ByteBuf the raw content of the TLV content) Creates a new HAProxyTLV
pack-priv	HAProxyTLV(final HAProxyTLV.Type the `Type` of the TLV type, final byte the byteValue of the TLV. This is especially important if non-standard TLVs are used typeByteValue, final ByteBuf the raw content of the TLV content) Creates a new HAProxyTLV

Method Summary

Modifier and Type	Method and Description
pack-priv int	contentNumBytes()
public HAProxyTLV	copy() Overrides io.netty.buffer.DefaultByteBufHolder.copy. Implements io.netty.buffer.ByteBufHolder.copy. Creates a deep copy of this `ByteBufHolder`.
public HAProxyTLV	duplicate() Overrides io.netty.buffer.DefaultByteBufHolder.duplicate. Implements io.netty.buffer.ByteBufHolder.duplicate. Duplicates this `ByteBufHolder`.
public HAProxyTLV	replace(ByteBuf content) Overrides io.netty.buffer.DefaultByteBufHolder.replace. Implements io.netty.buffer.ByteBufHolder.replace. Returns a new `ByteBufHolder` which contains the specified `content`.
public HAProxyTLV	retain() Overrides io.netty.buffer.DefaultByteBufHolder.retain. Implements io.netty.buffer.ByteBufHolder.retain. Increases the reference count by `1`.
public HAProxyTLV	retain(int increment) Overrides io.netty.buffer.DefaultByteBufHolder.retain. Implements io.netty.buffer.ByteBufHolder.retain. Increases the reference count by the specified `increment`.
public HAProxyTLV	retainedDuplicate() Overrides io.netty.buffer.DefaultByteBufHolder.retainedDuplicate. Implements io.netty.buffer.ByteBufHolder.retainedDuplicate. Duplicates this `ByteBufHolder`.
public String	toString() Overrides io.netty.buffer.DefaultByteBufHolder.toString. Returns a string representation of the object.
pack-priv int	Returns: the number of bytes. totalNumBytes() The size of this tlv in bytes.
public HAProxyTLV	touch() Overrides io.netty.buffer.DefaultByteBufHolder.touch. Implements io.netty.buffer.ByteBufHolder.touch. Records the current access location of this object for debugging purposes.
public HAProxyTLV	touch(Object hint) Overrides io.netty.buffer.DefaultByteBufHolder.touch. Implements io.netty.buffer.ByteBufHolder.touch. Records the current access location of this object with an additional arbitrary information for debugging purposes.
public HAProxyTLV.Type	type() Returns the `Type` of this TLV
public byte	typeByteValue() Returns the type of the TLV as byte

Inherited from io.netty.buffer.DefaultByteBufHolder:: content contentToString equals hashCode refCnt release release

Field Detail

type	back to summary
private final HAProxyTLV.Type type

typeByteValue	back to summary
private final byte typeByteValue

Constructor Detail

HAProxyTLV	back to summary
public HAProxyTLV(byte typeByteValue, ByteBuf content) Creates a new HAProxyTLV Parameters typeByteValue:byte the byteValue of the TLV. This is especially important if non-standard TLVs are used content:ByteBuf the raw content of the TLV

HAProxyTLV

back to summary

public HAProxyTLV(byte typeByteValue, ByteBuf content)

Creates a new HAProxyTLV

Parameters

typeByteValue:byte: the byteValue of the TLV. This is especially important if non-standard TLVs are used
content:ByteBuf: the raw content of the TLV

HAProxyTLV back to summary

HAProxyTLV	back to summary
public HAProxyTLV(HAProxyTLV.Type type, ByteBuf content) Creates a new HAProxyTLV Parameters type:HAProxyTLV.Type the `Type` of the TLV content:ByteBuf the raw content of the TLV

public HAProxyTLV(HAProxyTLV.Type type, ByteBuf content)

Creates a new HAProxyTLV

Parameters

type:HAProxyTLV.Type: the Type of the TLV
content:ByteBuf: the raw content of the TLV

HAProxyTLV back to summary

HAProxyTLV	back to summary
pack-priv HAProxyTLV(final HAProxyTLV.Type type, final byte typeByteValue, final ByteBuf content) Creates a new HAProxyTLV Parameters type:HAProxyTLV.Type the `Type` of the TLV typeByteValue:byte the byteValue of the TLV. This is especially important if non-standard TLVs are used content:ByteBuf the raw content of the TLV

pack-priv HAProxyTLV(final HAProxyTLV.Type type, final byte typeByteValue, final ByteBuf content)

Creates a new HAProxyTLV

Parameters

type:HAProxyTLV.Type: the Type of the TLV
typeByteValue:byte: the byteValue of the TLV. This is especially important if non-standard TLVs are used
content:ByteBuf: the raw content of the TLV

Method Detail

contentNumBytes	back to summary
pack-priv int contentNumBytes()

copy back to summary

copy	back to summary
public HAProxyTLV copy() Overrides io.netty.buffer.DefaultByteBufHolder.copy. Implements io.netty.buffer.ByteBufHolder.copy. Doc from io.netty.buffer.DefaultByteBufHolder.copy. Creates a deep copy of this `ByteBufHolder`. This method calls `replace(content().copy())` by default. Annotations @Override

public HAProxyTLV copy()

Overrides io.netty.buffer.DefaultByteBufHolder.copy.

Implements io.netty.buffer.ByteBufHolder.copy.

Doc from io.netty.buffer.DefaultByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.

This method calls replace(content().copy()) by default.

Annotations

@Override

duplicate back to summary

duplicate	back to summary
public HAProxyTLV duplicate() Overrides io.netty.buffer.DefaultByteBufHolder.duplicate. Implements io.netty.buffer.ByteBufHolder.duplicate. Doc from io.netty.buffer.DefaultByteBufHolder.duplicate. Duplicates this `ByteBufHolder`. Be aware that this will not automatically call `retain()`. This method calls `replace(content().duplicate())` by default. Annotations @Override

public HAProxyTLV duplicate()

Overrides io.netty.buffer.DefaultByteBufHolder.duplicate.

Implements io.netty.buffer.ByteBufHolder.duplicate.

Doc from io.netty.buffer.DefaultByteBufHolder.duplicate.

Duplicates this ByteBufHolder. Be aware that this will not automatically call retain().

This method calls replace(content().duplicate()) by default.

Annotations

@Override

replace back to summary

replace	back to summary
public HAProxyTLV replace(ByteBuf content) Overrides io.netty.buffer.DefaultByteBufHolder.replace. Implements io.netty.buffer.ByteBufHolder.replace. Doc from io.netty.buffer.DefaultByteBufHolder.replace. Returns a new `ByteBufHolder` which contains the specified `content`. Override this method to return a new instance of this object whose content is set to the specified `content`. The default implementation of `copy()`, `duplicate()` and `retainedDuplicate()` invokes this method to create a copy. Annotations @Override

public HAProxyTLV replace(ByteBuf content)

Overrides io.netty.buffer.DefaultByteBufHolder.replace.

Implements io.netty.buffer.ByteBufHolder.replace.

Doc from io.netty.buffer.DefaultByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.

Override this method to return a new instance of this object whose content is set to the specified content. The default implementation of copy(), duplicate() and retainedDuplicate() invokes this method to create a copy.

Annotations

@Override

retain back to summary

retain	back to summary
public HAProxyTLV retain() Overrides io.netty.buffer.DefaultByteBufHolder.retain. Implements io.netty.buffer.ByteBufHolder.retain. Doc from io.netty.util.ReferenceCounted.retain. Increases the reference count by `1`. Annotations @Override

public HAProxyTLV retain()

Overrides io.netty.buffer.DefaultByteBufHolder.retain.

Implements io.netty.buffer.ByteBufHolder.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by 1.

Annotations

@Override

retain back to summary

retain	back to summary
public HAProxyTLV retain(int increment) Overrides io.netty.buffer.DefaultByteBufHolder.retain. Implements io.netty.buffer.ByteBufHolder.retain. Doc from io.netty.util.ReferenceCounted.retain. Increases the reference count by the specified `increment`. Annotations @Override

public HAProxyTLV retain(int increment)

Overrides io.netty.buffer.DefaultByteBufHolder.retain.

Implements io.netty.buffer.ByteBufHolder.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by the specified increment.

Annotations

@Override

retainedDuplicate back to summary

retainedDuplicate	back to summary
public HAProxyTLV retainedDuplicate() Overrides io.netty.buffer.DefaultByteBufHolder.retainedDuplicate. Implements io.netty.buffer.ByteBufHolder.retainedDuplicate. Doc from io.netty.buffer.DefaultByteBufHolder.retainedDuplicate. Duplicates this `ByteBufHolder`. This method returns a retained duplicate unlike `duplicate()`. This method calls `replace(content().retainedDuplicate())` by default. Annotations @Override

public HAProxyTLV retainedDuplicate()

Overrides io.netty.buffer.DefaultByteBufHolder.retainedDuplicate.

Implements io.netty.buffer.ByteBufHolder.retainedDuplicate.

Doc from io.netty.buffer.DefaultByteBufHolder.retainedDuplicate.

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike duplicate().

This method calls replace(content().retainedDuplicate()) by default.

Annotations

@Override

toString	back to summary
public String toString() Overrides io.netty.buffer.DefaultByteBufHolder.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides io.netty.buffer.DefaultByteBufHolder.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

totalNumBytes	back to summary
pack-priv int totalNumBytes() The size of this tlv in bytes. Returns:int the number of bytes.

totalNumBytes

back to summary

pack-priv int totalNumBytes()

The size of this tlv in bytes.

Returns:int: the number of bytes.

touch back to summary

touch	back to summary
public HAProxyTLV touch() Overrides io.netty.buffer.DefaultByteBufHolder.touch. Implements io.netty.buffer.ByteBufHolder.touch. Doc from io.netty.util.ReferenceCounted.touch. 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)`. Annotations @Override

public HAProxyTLV touch()

Overrides io.netty.buffer.DefaultByteBufHolder.touch.

Implements io.netty.buffer.ByteBufHolder.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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).

Annotations

@Override

touch back to summary

touch	back to summary
public HAProxyTLV touch(Object hint) Overrides io.netty.buffer.DefaultByteBufHolder.touch. Implements io.netty.buffer.ByteBufHolder.touch. Doc from io.netty.util.ReferenceCounted.touch. 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`. Annotations @Override

public HAProxyTLV touch(Object hint)

Overrides io.netty.buffer.DefaultByteBufHolder.touch.

Implements io.netty.buffer.ByteBufHolder.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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.

Annotations

@Override

type	back to summary
public HAProxyTLV.Type type() Returns the `Type` of this TLV

typeByteValue	back to summary
public byte typeByteValue() Returns the type of the TLV as byte

io.netty.handler.codec.haproxy back to summary

public final Enum HAProxyTLV.Type

Class Inheritance

extends Enum<HAProxyTLV.Type>

java.lang.Object
java.lang.Enum
io.netty.handler.codec.haproxy.HAProxyTLV.Type

The registered types a TLV can have regarding the PROXY protocol 1.5 spec

Field Summary

Modifier and Type	Field and Description
public static final HAProxyTLV.Type	OTHER A TLV type that is not officially defined in the spec.
public static final HAProxyTLV.Type	PP2_TYPE_ALPN
public static final HAProxyTLV.Type	PP2_TYPE_AUTHORITY
public static final HAProxyTLV.Type	PP2_TYPE_NETNS
public static final HAProxyTLV.Type	PP2_TYPE_SSL
public static final HAProxyTLV.Type	PP2_TYPE_SSL_CN
public static final HAProxyTLV.Type	PP2_TYPE_SSL_VERSION

Constructor Summary

Access	Constructor and Description
private	Type()

Method Summary

Modifier and Type	Method and Description
public static byte	Returns: the byte value of the `Type`. byteValueForType(HAProxyTLV.Type the `Type` type) Returns the byte value for the `Type` as defined in the PROXY protocol 1.5 spec.
public static HAProxyTLV.Type	Returns: the `Type` of a TLV typeForByteValue(byte the byte for a type byteValue) Returns the `Type` for a specific byte value as defined in the PROXY protocol 1.5 spec If the byte value is not an official one, it will return `Type#OTHER`.
public static HAProxyTLV.Type	valueOf(String name)
public static HAProxyTLV.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

OTHER	back to summary
public static final HAProxyTLV.Type OTHER A TLV type that is not officially defined in the spec. May be used for nonstandard TLVs

PP2_TYPE_ALPN	back to summary
public static final HAProxyTLV.Type PP2_TYPE_ALPN

PP2_TYPE_AUTHORITY	back to summary
public static final HAProxyTLV.Type PP2_TYPE_AUTHORITY

PP2_TYPE_NETNS	back to summary
public static final HAProxyTLV.Type PP2_TYPE_NETNS

PP2_TYPE_SSL	back to summary
public static final HAProxyTLV.Type PP2_TYPE_SSL

PP2_TYPE_SSL_CN	back to summary
public static final HAProxyTLV.Type PP2_TYPE_SSL_CN

PP2_TYPE_SSL_VERSION	back to summary
public static final HAProxyTLV.Type PP2_TYPE_SSL_VERSION

Constructor Detail

Type	back to summary
private Type()

Method Detail

byteValueForType back to summary

byteValueForType	back to summary
public static byte byteValueForType(HAProxyTLV.Type type) Returns the byte value for the `Type` as defined in the PROXY protocol 1.5 spec. Parameters type:HAProxyTLV.Type the `Type` Returns:byte the byte value of the `Type`.

public static byte byteValueForType(HAProxyTLV.Type type)

Returns the byte value for the Type as defined in the PROXY protocol 1.5 spec.

Parameters

type:HAProxyTLV.Type: the Type

Returns:byte

the byte value of the Type.

typeForByteValue back to summary

typeForByteValue	back to summary
public static HAProxyTLV.Type typeForByteValue(byte byteValue) Returns the `Type` for a specific byte value as defined in the PROXY protocol 1.5 spec If the byte value is not an official one, it will return `Type#OTHER`. Parameters byteValue:byte the byte for a type Returns:HAProxyTLV.Type the `Type` of a TLV

public static HAProxyTLV.Type typeForByteValue(byte byteValue)

Returns the Type for a specific byte value as defined in the PROXY protocol 1.5 spec

If the byte value is not an official one, it will return Type#OTHER.

Parameters

byteValue:byte: the byte for a type

Returns:HAProxyTLV.Type

the Type of a TLV

valueOf	back to summary
public static HAProxyTLV.Type valueOf(String name)

values	back to summary
public static HAProxyTLV.Type[] values()

public Class HAProxyTLV

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum HAProxyTLV.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail