Package io.netty.handler.codec.haproxy

Class HAProxyTLV

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

io.netty.handler.codec.haproxy.HAProxyTLV

All Implemented Interfaces:

ByteBufHolder, ReferenceCounted

Direct Known Subclasses:

HAProxySSLTLV

public class HAProxyTLV
extends DefaultByteBufHolder

A Type-Length Value (TLV vector) that can be added to the PROXY protocol to include additional information like SSL information.

See Also:

HAProxySSLTLV

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
HAProxyTLV(byte typeByteValue, ByteBuf content)	Creates a new HAProxyTLV
HAProxyTLV(HAProxyTLV.Type type, ByteBuf content)	Creates a new HAProxyTLV

Method Summary

Modifier and Type	Method	Description
HAProxyTLV	copy()	Creates a deep copy of this ByteBufHolder.
HAProxyTLV	duplicate()	Duplicates this ByteBufHolder.
HAProxyTLV	replace(ByteBuf content)	Returns a new ByteBufHolder which contains the specified content.
HAProxyTLV	retain()	Increases the reference count by 1.
HAProxyTLV	retain(int increment)	Increases the reference count by the specified increment.
HAProxyTLV	retainedDuplicate()	Duplicates this ByteBufHolder.
java.lang.String	toString()
HAProxyTLV	touch()	Records the current access location of this object for debugging purposes.
HAProxyTLV	touch(java.lang.Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.
HAProxyTLV.Type	type()	Returns the HAProxyTLV.Type of this TLV
byte	typeByteValue()	Returns the type of the TLV as byte

Methods inherited from class io.netty.buffer.DefaultByteBufHolder

content, contentToString, equals, hashCode, refCnt, release, release

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HAProxyTLV

public HAProxyTLV(byte typeByteValue,
                  ByteBuf content)

Creates a new HAProxyTLV

Parameters:

typeByteValue - the byteValue of the TLV. This is especially important if non-standard TLVs are used

content - the raw content of the TLV

HAProxyTLV

public HAProxyTLV(HAProxyTLV.Type type,
                  ByteBuf content)

Creates a new HAProxyTLV

Parameters:

type - the HAProxyTLV.Type of the TLV

content - the raw content of the TLV

Method Detail

type

public HAProxyTLV.Type type()

Returns the HAProxyTLV.Type of this TLV

typeByteValue

public byte typeByteValue()

Returns the type of the TLV as byte

copy

public HAProxyTLV copy()

Description copied from class: DefaultByteBufHolder

Creates a deep copy of this ByteBufHolder.

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

Specified by:

copy in interface ByteBufHolder

Overrides:

copy in class DefaultByteBufHolder

duplicate

public HAProxyTLV duplicate()

Description copied from class: DefaultByteBufHolder

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

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

Specified by:

duplicate in interface ByteBufHolder

Overrides:

duplicate in class DefaultByteBufHolder

retainedDuplicate

public HAProxyTLV retainedDuplicate()

Description copied from class: DefaultByteBufHolder

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

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

Specified by:

retainedDuplicate in interface ByteBufHolder

Overrides:

retainedDuplicate in class DefaultByteBufHolder

See Also:

ByteBuf.retainedDuplicate()

replace

public HAProxyTLV replace(ByteBuf content)

Description copied from class: DefaultByteBufHolder

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 DefaultByteBufHolder.copy(), DefaultByteBufHolder.duplicate() and DefaultByteBufHolder.retainedDuplicate() invokes this method to create a copy.

Specified by:

replace in interface ByteBufHolder

Overrides:

replace in class DefaultByteBufHolder

retain

public HAProxyTLV retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class DefaultByteBufHolder

retain

public HAProxyTLV retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class DefaultByteBufHolder

touch

public HAProxyTLV 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 ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class DefaultByteBufHolder

touch

public HAProxyTLV touch(java.lang.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.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class DefaultByteBufHolder

toString

public java.lang.String toString()

Overrides:

toString in class DefaultByteBufHolder