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
A Type-Length Value (TLV vector) that can be added to the PROXY protocol
to include additional information like SSL information.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
The registered types a TLV can have regarding the PROXY protocol 1.5 spec -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionHAProxyTLV
(byte typeByteValue, ByteBuf content) Creates a new HAProxyTLVHAProxyTLV
(HAProxyTLV.Type type, byte typeByteValue, ByteBuf content) Creates a new HAProxyTLVHAProxyTLV
(HAProxyTLV.Type type, ByteBuf content) Creates a new HAProxyTLV -
Method Summary
Modifier and TypeMethodDescription(package private) int
copy()
Creates a deep copy of thisByteBufHolder
.Duplicates thisByteBufHolder
.Returns a newByteBufHolder
which contains the specifiedcontent
.retain()
Increases the reference count by1
.retain
(int increment) Increases the reference count by the specifiedincrement
.Duplicates thisByteBufHolder
.toString()
(package private) int
The size of this tlv in bytes.touch()
Records the current access location of this object for debugging purposes.Records the current access location of this object with an additional arbitrary information for debugging purposes.type()
Returns theHAProxyTLV.Type
of this TLVbyte
Returns the type of the TLV as byteMethods inherited from class io.netty.buffer.DefaultByteBufHolder
content, contentToString, equals, hashCode, refCnt, release, release
-
Field Details
-
type
-
typeByteValue
private final byte typeByteValue
-
-
Constructor Details
-
HAProxyTLV
Creates a new HAProxyTLV- Parameters:
typeByteValue
- the byteValue of the TLV. This is especially important if non-standard TLVs are usedcontent
- the raw content of the TLV
-
HAProxyTLV
Creates a new HAProxyTLV- Parameters:
type
- theHAProxyTLV.Type
of the TLVcontent
- the raw content of the TLV
-
HAProxyTLV
HAProxyTLV(HAProxyTLV.Type type, byte typeByteValue, ByteBuf content) Creates a new HAProxyTLV- Parameters:
type
- theHAProxyTLV.Type
of the TLVtypeByteValue
- the byteValue of the TLV. This is especially important if non-standard TLVs are usedcontent
- the raw content of the TLV
-
-
Method Details
-
totalNumBytes
int totalNumBytes()The size of this tlv in bytes.- Returns:
- the number of bytes.
-
contentNumBytes
int contentNumBytes() -
type
Returns theHAProxyTLV.Type
of this TLV -
typeByteValue
public byte typeByteValue()Returns the type of the TLV as byte -
copy
Description copied from class:DefaultByteBufHolder
Creates a deep copy of thisByteBufHolder
.This method calls
replace(content().copy())
by default.- Specified by:
copy
in interfaceByteBufHolder
- Overrides:
copy
in classDefaultByteBufHolder
-
duplicate
Description copied from class:DefaultByteBufHolder
Duplicates thisByteBufHolder
. Be aware that this will not automatically callByteBufHolder.retain()
.This method calls
replace(content().duplicate())
by default.- Specified by:
duplicate
in interfaceByteBufHolder
- Overrides:
duplicate
in classDefaultByteBufHolder
-
retainedDuplicate
Description copied from class:DefaultByteBufHolder
Duplicates thisByteBufHolder
. This method returns a retained duplicate unlikeByteBufHolder.duplicate()
.This method calls
replace(content().retainedDuplicate())
by default.- Specified by:
retainedDuplicate
in interfaceByteBufHolder
- Overrides:
retainedDuplicate
in classDefaultByteBufHolder
- See Also:
-
replace
Description copied from class:DefaultByteBufHolder
Returns a newByteBufHolder
which contains the specifiedcontent
.Override this method to return a new instance of this object whose content is set to the specified
content
. The default implementation ofDefaultByteBufHolder.copy()
,DefaultByteBufHolder.duplicate()
andDefaultByteBufHolder.retainedDuplicate()
invokes this method to create a copy.- Specified by:
replace
in interfaceByteBufHolder
- Overrides:
replace
in classDefaultByteBufHolder
-
retain
Description copied from interface:ReferenceCounted
Increases the reference count by1
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceReferenceCounted
- Overrides:
retain
in classDefaultByteBufHolder
-
retain
Description copied from interface:ReferenceCounted
Increases the reference count by the specifiedincrement
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceReferenceCounted
- Overrides:
retain
in classDefaultByteBufHolder
-
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 viaResourceLeakDetector
. This method is a shortcut totouch(null)
.- Specified by:
touch
in interfaceByteBufHolder
- Specified by:
touch
in interfaceReferenceCounted
- Overrides:
touch
in classDefaultByteBufHolder
-
touch
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 viaResourceLeakDetector
.- Specified by:
touch
in interfaceByteBufHolder
- Specified by:
touch
in interfaceReferenceCounted
- Overrides:
touch
in classDefaultByteBufHolder
-
toString
- Overrides:
toString
in classDefaultByteBufHolder
-