Class DefaultBinaryMemcacheResponse

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.handler.codec.memcache.AbstractMemcacheObject

io.netty.handler.codec.memcache.binary.AbstractBinaryMemcacheMessage

io.netty.handler.codec.memcache.binary.DefaultBinaryMemcacheResponse

All Implemented Interfaces:

DecoderResultProvider, BinaryMemcacheMessage, BinaryMemcacheResponse, MemcacheMessage, MemcacheObject, ReferenceCounted

Direct Known Subclasses:

DefaultFullBinaryMemcacheResponse

@UnstableApi
public class DefaultBinaryMemcacheResponse
extends AbstractBinaryMemcacheMessage
implements BinaryMemcacheResponse

The default implementation of the BinaryMemcacheResponse.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	RESPONSE_MAGIC_BYTE	Default magic byte for a request.

Constructor Summary

Constructors

Constructor	Description
DefaultBinaryMemcacheResponse()	Create a new DefaultBinaryMemcacheResponse with the header only.
DefaultBinaryMemcacheResponse(ByteBuf key)	Create a new DefaultBinaryMemcacheResponse with the header and key.
DefaultBinaryMemcacheResponse(ByteBuf key, ByteBuf extras)	Create a new DefaultBinaryMemcacheResponse with the header, 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 class AbstractBinaryMemcacheMessage

cas, dataType, deallocate, 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.
protected void	deallocate()	Called once AbstractReferenceCounted.refCnt() is equals 0.
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 opcode)	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 class AbstractMemcacheObject

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 class AbstractReferenceCounted

refCnt, release, release, setRefCnt

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.
protected final void	setRefCnt(int refCnt)	An unsafe operation intended for use by a subclass that sets the reference count of the buffer directly

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RESPONSE_MAGIC_BYTE

public static final byte RESPONSE_MAGIC_BYTE

Default magic byte for a request.

See Also:

• Constant Field Values

Constructor Details

DefaultBinaryMemcacheResponse

public DefaultBinaryMemcacheResponse()

Create a new DefaultBinaryMemcacheResponse with the header only.

DefaultBinaryMemcacheResponse

public DefaultBinaryMemcacheResponse(ByteBuf key)

Create a new DefaultBinaryMemcacheResponse with the header and key.

Parameters:

key - the key to use.

DefaultBinaryMemcacheResponse

public DefaultBinaryMemcacheResponse(ByteBuf key,
 ByteBuf extras)

Create a new DefaultBinaryMemcacheResponse with the header, key and extras.

Parameters:

key - the key to use.

extras - the extras to use.

Method Details

status

public short status()

Description copied from interface: BinaryMemcacheResponse

Returns the status of the response.

Specified by:

status in interface BinaryMemcacheResponse

Returns:

the status of the response.

setStatus

public BinaryMemcacheResponse setStatus(short status)

Description copied from interface: BinaryMemcacheResponse

Sets the status of the response.

Specified by:

setStatus in interface BinaryMemcacheResponse

Parameters:

status - the status to set.

retain

public BinaryMemcacheResponse retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface BinaryMemcacheMessage

Specified by:

retain in interface BinaryMemcacheResponse

Specified by:

retain in interface MemcacheMessage

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractBinaryMemcacheMessage

retain

public BinaryMemcacheResponse retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface BinaryMemcacheMessage

Specified by:

retain in interface BinaryMemcacheResponse

Specified by:

retain in interface MemcacheMessage

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractBinaryMemcacheMessage

touch

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

Specified by:

touch in interface MemcacheMessage

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractBinaryMemcacheMessage

touch

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

Specified by:

touch in interface MemcacheMessage

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class AbstractBinaryMemcacheMessage