public interface BinaryMemcacheMessage extends MemcacheMessage
BinaryMemcacheRequest
and BinaryMemcacheResponse
.
A BinaryMemcacheMessage
always consists of a header and optional extras or/and
a key.BinaryMemcacheRequest
,
BinaryMemcacheResponse
Modifier and Type | Method and Description |
---|---|
long |
getCAS()
Returns the CAS identifier.
|
byte |
getDataType()
Returns the data type of the message.
|
ByteBuf |
getExtras()
Returns a
ByteBuf representation of the optional extras. |
byte |
getExtrasLength()
Return the extras length of the message.
|
ByteBuf |
getFramingExtras()
Returns a
ByteBuf representation of the optional framing extras. |
byte |
getFramingExtrasLength()
Return the framing extras length of the message.
|
byte[] |
getKey()
Returns the optional key of the document.
|
short |
getKeyLength()
Returns the key length of the message.
|
byte |
getMagic()
Returns the magic byte for the message.
|
int |
getOpaque()
Returns the opaque value.
|
byte |
getOpcode()
Returns the opcode for the message.
|
int |
getTotalBodyLength()
Returns the total body length.
|
BinaryMemcacheMessage |
setCAS(long cas)
Sets the CAS identifier.
|
BinaryMemcacheMessage |
setDataType(byte dataType)
Sets the data type of the message.
|
BinaryMemcacheMessage |
setExtras(ByteBuf extras)
Sets the extras buffer on the message.
|
BinaryMemcacheMessage |
setExtrasLength(byte extrasLength)
Set the extras length of the message.
|
BinaryMemcacheMessage |
setFramingExtras(ByteBuf framingExtras)
Sets the framing extras buffer on the message.
|
BinaryMemcacheMessage |
setFramingExtrasLength(byte framingExtrasLength)
Set the framing extras length of the message.
|
BinaryMemcacheMessage |
setKey(byte[] key)
Sets the key of the document.
|
BinaryMemcacheMessage |
setKeyLength(short keyLength)
Set the key length of the message.
|
BinaryMemcacheMessage |
setMagic(byte magic)
Sets the magic byte.
|
BinaryMemcacheMessage |
setOpaque(int opaque)
Sets the opaque value.
|
BinaryMemcacheMessage |
setOpcode(byte code)
Sets the opcode for the message.
|
BinaryMemcacheMessage |
setTotalBodyLength(int totalBodyLength)
Sets the total body length.
|
getDecoderResult, setDecoderResult
byte getMagic()
BinaryMemcacheMessage setMagic(byte magic)
magic
- the magic byte to use.for typesafe opcodes.
byte getOpcode()
BinaryMemcacheMessage setOpcode(byte code)
code
- the opcode to use.short getKeyLength()
BinaryMemcacheMessage setKeyLength(short keyLength)
keyLength
- the key length to use.byte getExtrasLength()
BinaryMemcacheMessage setExtrasLength(byte extrasLength)
extrasLength
- the extras length.byte getDataType()
BinaryMemcacheMessage setDataType(byte dataType)
dataType
- the data type of the message.int getTotalBodyLength()
BinaryMemcacheMessage setTotalBodyLength(int totalBodyLength)
totalBodyLength
- the total body length.int getOpaque()
BinaryMemcacheMessage setOpaque(int opaque)
opaque
- the opqaue value to use.long getCAS()
BinaryMemcacheMessage setCAS(long cas)
cas
- the CAS identifier to use.byte[] getKey()
BinaryMemcacheMessage setKey(byte[] key)
key
- the key of the message.ByteBuf getExtras()
ByteBuf
representation of the optional extras.BinaryMemcacheMessage setExtras(ByteBuf extras)
extras
- the extras buffer of the document.ByteBuf getFramingExtras()
ByteBuf
representation of the optional framing extras.BinaryMemcacheMessage setFramingExtras(ByteBuf framingExtras)
framingExtras
- the framing extras buffer of the document.byte getFramingExtrasLength()
BinaryMemcacheMessage setFramingExtrasLength(byte framingExtrasLength)
framingExtrasLength
- the framing extras length.Copyright © 2021 Couchbase, Inc.. All rights reserved.