Interface BinaryMemcacheMessage
- All Superinterfaces:
DecoderResultProvider
,MemcacheMessage
,MemcacheObject
,ReferenceCounted
- All Known Subinterfaces:
BinaryMemcacheRequest
,BinaryMemcacheResponse
,FullBinaryMemcacheRequest
,FullBinaryMemcacheResponse
- All Known Implementing Classes:
AbstractBinaryMemcacheMessage
,DefaultBinaryMemcacheRequest
,DefaultBinaryMemcacheResponse
,DefaultFullBinaryMemcacheRequest
,DefaultFullBinaryMemcacheResponse
An interface that defines a binary Memcache message, providing common properties for
BinaryMemcacheRequest
and BinaryMemcacheResponse
.
A BinaryMemcacheMessage
always consists of a header and optional extras or/and
a key.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionlong
cas()
Returns the CAS identifier.byte
dataType()
Returns the data type of the message.extras()
Returns aByteBuf
representation of the optional extras.byte
Return the extras length of the message.key()
Returns the optional key of the document.short
Returns the key length of the message.byte
magic()
Returns the magic byte for the message.int
opaque()
Returns the opaque value.byte
opcode()
Returns the opcode for the message.retain()
Increases the reference count by1
.retain
(int increment) Increases the reference count by the specifiedincrement
.setCas
(long cas) Sets the CAS identifier.setDataType
(byte dataType) Sets the data type of the message.Sets the extras buffer on the message.Sets the key of the document.setMagic
(byte magic) Sets the magic byte.setOpaque
(int opaque) Sets the opaque value.setOpcode
(byte code) Sets the opcode for the message.setTotalBodyLength
(int totalBodyLength) Sets the total body length.int
Returns the total body length.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.Methods inherited from interface io.netty.handler.codec.DecoderResultProvider
decoderResult, setDecoderResult
Methods inherited from interface io.netty.util.ReferenceCounted
refCnt, release, release
-
Method Details
-
magic
byte magic()Returns the magic byte for the message.- Returns:
- the magic byte.
-
setMagic
Sets the magic byte.- Parameters:
magic
- the magic byte to use.- See Also:
-
opcode
byte opcode()Returns the opcode for the message.- Returns:
- the opcode.
-
setOpcode
Sets the opcode for the message.- Parameters:
code
- the opcode to use.
-
keyLength
short keyLength()Returns the key length of the message. This may return 0, since the key is optional.- Returns:
- the key length.
-
extrasLength
byte extrasLength()Return the extras length of the message. This may be 0, since the extras content is optional.- Returns:
- the extras length.
-
dataType
byte dataType()Returns the data type of the message.- Returns:
- the data type of the message.
-
setDataType
Sets the data type of the message.- Parameters:
dataType
- the data type of the message.
-
totalBodyLength
int totalBodyLength()Returns the total body length. Note that this may be 0, since the body is optional.- Returns:
- the total body length.
-
setTotalBodyLength
Sets the total body length. Note that this may be 0, since the body length is optional.- Parameters:
totalBodyLength
- the total body length.
-
opaque
int opaque()Returns the opaque value.- Returns:
- the opaque value.
-
setOpaque
Sets the opaque value.- Parameters:
opaque
- the opaque value to use.
-
cas
long cas()Returns the CAS identifier.- Returns:
- the CAS identifier.
-
setCas
Sets the CAS identifier.- Parameters:
cas
- the CAS identifier to use.
-
key
ByteBuf key()Returns the optional key of the document.- Returns:
- the key of the document.
-
setKey
Sets the key of the document.ReferenceCounted.release()
ownership ofkey
is transferred to thisBinaryMemcacheMessage
.- Parameters:
key
- the key of the message.ReferenceCounted.release()
ownership is transferred to thisBinaryMemcacheMessage
.
-
extras
ByteBuf extras()Returns aByteBuf
representation of the optional extras.- Returns:
- the optional extras.
-
setExtras
Sets the extras buffer on the message.ReferenceCounted.release()
ownership ofextras
is transferred to thisBinaryMemcacheMessage
.- Parameters:
extras
- the extras buffer of the document.ReferenceCounted.release()
ownership is transferred to thisBinaryMemcacheMessage
.
-
retain
BinaryMemcacheMessage retain()Increases the reference count by1
.- Specified by:
retain
in interfaceMemcacheMessage
- Specified by:
retain
in interfaceReferenceCounted
-
retain
Increases the reference count by the specifiedincrement
.- Specified by:
retain
in interfaceMemcacheMessage
- Specified by:
retain
in interfaceReferenceCounted
-
touch
BinaryMemcacheMessage 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 interfaceMemcacheMessage
- Specified by:
touch
in interfaceReferenceCounted
-
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 interfaceMemcacheMessage
- Specified by:
touch
in interfaceReferenceCounted
-