Interface BinaryMemcacheResponse

All Superinterfaces:

BinaryMemcacheMessage, DecoderResultProvider, MemcacheMessage, MemcacheObject, ReferenceCounted

All Known Subinterfaces:

FullBinaryMemcacheResponse

All Known Implementing Classes:

DefaultBinaryMemcacheResponse, DefaultFullBinaryMemcacheResponse

@UnstableApi
public interface BinaryMemcacheResponse
extends BinaryMemcacheMessage

Represents a full BinaryMemcacheResponse, which contains the header and optional key and extras.

Method Summary

Modifier and Type	Method	Description
BinaryMemcacheResponse	retain()	Increases the reference count by 1.
BinaryMemcacheResponse	retain(int increment)	Increases the reference count by the specified increment.
BinaryMemcacheResponse	setStatus(short status)	Sets the status of the response.
short	status()	Returns the status of the response.
BinaryMemcacheResponse	touch()	Records the current access location of this object for debugging purposes.
BinaryMemcacheResponse	touch(Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from interface BinaryMemcacheMessage

cas, dataType, extras, extrasLength, key, keyLength, magic, opaque, opcode, setCas, setDataType, setExtras, setKey, setMagic, setOpaque, setOpcode, setTotalBodyLength, totalBodyLength

Modifier and Type	Method	Description
long	cas()	Returns the CAS identifier.
byte	dataType()	Returns the data type of the message.
ByteBuf	extras()	Returns a ByteBuf representation of the optional extras.
byte	extrasLength()	Return the extras length of the message.
ByteBuf	key()	Returns the optional key of the document.
short	keyLength()	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.
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	setKey(ByteBuf key)	Sets the key of the document.
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.
int	totalBodyLength()	Returns the total body length.

Methods inherited from interface DecoderResultProvider

decoderResult, setDecoderResult

Modifier and Type	Method	Description
DecoderResult	decoderResult()	Returns the result of decoding this object.
void	setDecoderResult(DecoderResult result)	Updates the result of decoding this object.

Methods inherited from interface ReferenceCounted

refCnt, release, release

Modifier and Type	Method	Description
int	refCnt()	Returns the reference count of this object.
boolean	release()	Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement)	Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Method Details

status

short status()

Returns the status of the response.

Returns:

the status of the response.

setStatus

BinaryMemcacheResponse setStatus(short status)

Sets the status of the response.

Parameters:

status - the status to set.

retain

BinaryMemcacheResponse retain()

Description copied from interface: BinaryMemcacheMessage

Increases the reference count by 1.

Specified by:

retain in interface BinaryMemcacheMessage

Specified by:

retain in interface MemcacheMessage

Specified by:

retain in interface ReferenceCounted

retain

BinaryMemcacheResponse retain(int increment)

Description copied from interface: BinaryMemcacheMessage

Increases the reference count by the specified increment.

Specified by:

retain in interface BinaryMemcacheMessage

Specified by:

retain in interface MemcacheMessage

Specified by:

retain in interface ReferenceCounted

touch

BinaryMemcacheResponse 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 BinaryMemcacheMessage

Specified by:

touch in interface MemcacheMessage

Specified by:

touch in interface ReferenceCounted

touch

BinaryMemcacheResponse touch(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 BinaryMemcacheMessage

Specified by:

touch in interface MemcacheMessage

Specified by:

touch in interface ReferenceCounted