Package io.netty.handler.codec.memcache.binary

Class AbstractBinaryMemcacheMessage

java.lang.Object

io.netty.util.AbstractReferenceCounted

io.netty.handler.codec.memcache.AbstractMemcacheObject

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

All Implemented Interfaces:

DecoderResultProvider, BinaryMemcacheMessage, MemcacheMessage, MemcacheObject, ReferenceCounted

Direct Known Subclasses:

DefaultBinaryMemcacheRequest, DefaultBinaryMemcacheResponse

@UnstableApi
public abstract class AbstractBinaryMemcacheMessage
extends AbstractMemcacheObject
implements BinaryMemcacheMessage

Default implementation of a BinaryMemcacheMessage.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBinaryMemcacheMessage(ByteBuf key, ByteBuf extras)	Create a new instance with all properties set.

Method Summary

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	retain()	Increases the reference count by 1.
BinaryMemcacheMessage	retain(int increment)	Increases the reference count by the specified increment.
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.
BinaryMemcacheMessage	touch()	Records the current access location of this object for debugging purposes.
BinaryMemcacheMessage	touch(java.lang.Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class io.netty.handler.codec.memcache.AbstractMemcacheObject

decoderResult, setDecoderResult

Methods inherited from class io.netty.util.AbstractReferenceCounted

refCnt, release, release, setRefCnt

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.handler.codec.DecoderResultProvider

decoderResult, setDecoderResult

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Constructor Detail

AbstractBinaryMemcacheMessage

protected AbstractBinaryMemcacheMessage(ByteBuf key,
                                        ByteBuf extras)

Create a new instance with all properties set.

Parameters:

key - the message key.

extras - the message extras.

Method Detail

key

public ByteBuf key()

Description copied from interface: BinaryMemcacheMessage

Returns the optional key of the document.

Specified by:

key in interface BinaryMemcacheMessage

Returns:

the key of the document.

extras

public ByteBuf extras()

Description copied from interface: BinaryMemcacheMessage

Returns a ByteBuf representation of the optional extras.

Specified by:

extras in interface BinaryMemcacheMessage

Returns:

the optional extras.

setKey

public BinaryMemcacheMessage setKey(ByteBuf key)

Description copied from interface: BinaryMemcacheMessage

Sets the key of the document. ReferenceCounted.release() ownership of key is transferred to this BinaryMemcacheMessage.

Specified by:

setKey in interface BinaryMemcacheMessage

Parameters:

key - the key of the message. ReferenceCounted.release() ownership is transferred to this BinaryMemcacheMessage.

setExtras

public BinaryMemcacheMessage setExtras(ByteBuf extras)

Description copied from interface: BinaryMemcacheMessage

Sets the extras buffer on the message. ReferenceCounted.release() ownership of extras is transferred to this BinaryMemcacheMessage.

Specified by:

setExtras in interface BinaryMemcacheMessage

Parameters:

extras - the extras buffer of the document. ReferenceCounted.release() ownership is transferred to this BinaryMemcacheMessage.

magic

public byte magic()

Description copied from interface: BinaryMemcacheMessage

Returns the magic byte for the message.

Specified by:

magic in interface BinaryMemcacheMessage

Returns:

the magic byte.

setMagic

public BinaryMemcacheMessage setMagic(byte magic)

Description copied from interface: BinaryMemcacheMessage

Sets the magic byte.

Specified by:

setMagic in interface BinaryMemcacheMessage

Parameters:

magic - the magic byte to use.

See Also:

for typesafe opcodes.

cas

public long cas()

Description copied from interface: BinaryMemcacheMessage

Returns the CAS identifier.

Specified by:

cas in interface BinaryMemcacheMessage

Returns:

the CAS identifier.

setCas

public BinaryMemcacheMessage setCas(long cas)

Description copied from interface: BinaryMemcacheMessage

Sets the CAS identifier.

Specified by:

setCas in interface BinaryMemcacheMessage

Parameters:

cas - the CAS identifier to use.

opaque

public int opaque()

Description copied from interface: BinaryMemcacheMessage

Returns the opaque value.

Specified by:

opaque in interface BinaryMemcacheMessage

Returns:

the opaque value.

setOpaque

public BinaryMemcacheMessage setOpaque(int opaque)

Description copied from interface: BinaryMemcacheMessage

Sets the opaque value.

Specified by:

setOpaque in interface BinaryMemcacheMessage

Parameters:

opaque - the opaque value to use.

totalBodyLength

public int totalBodyLength()

Description copied from interface: BinaryMemcacheMessage

Returns the total body length.

Note that this may be 0, since the body is optional.

Specified by:

totalBodyLength in interface BinaryMemcacheMessage

Returns:

the total body length.

setTotalBodyLength

public BinaryMemcacheMessage setTotalBodyLength(int totalBodyLength)

Description copied from interface: BinaryMemcacheMessage

Sets the total body length.

Note that this may be 0, since the body length is optional.

Specified by:

setTotalBodyLength in interface BinaryMemcacheMessage

Parameters:

totalBodyLength - the total body length.

dataType

public byte dataType()

Description copied from interface: BinaryMemcacheMessage

Returns the data type of the message.

Specified by:

dataType in interface BinaryMemcacheMessage

Returns:

the data type of the message.

setDataType

public BinaryMemcacheMessage setDataType(byte dataType)

Description copied from interface: BinaryMemcacheMessage

Sets the data type of the message.

Specified by:

setDataType in interface BinaryMemcacheMessage

Parameters:

dataType - the data type of the message.

extrasLength

public byte extrasLength()

Description copied from interface: BinaryMemcacheMessage

Return the extras length of the message.

This may be 0, since the extras content is optional.

Specified by:

extrasLength in interface BinaryMemcacheMessage

Returns:

the extras length.

keyLength

public short keyLength()

Description copied from interface: BinaryMemcacheMessage

Returns the key length of the message.

This may return 0, since the key is optional.

Specified by:

keyLength in interface BinaryMemcacheMessage

Returns:

the key length.

opcode

public byte opcode()

Description copied from interface: BinaryMemcacheMessage

Returns the opcode for the message.

Specified by:

opcode in interface BinaryMemcacheMessage

Returns:

the opcode.

setOpcode

public BinaryMemcacheMessage setOpcode(byte opcode)

Description copied from interface: BinaryMemcacheMessage

Sets the opcode for the message.

Specified by:

setOpcode in interface BinaryMemcacheMessage

Parameters:

opcode - the opcode to use.

retain

public BinaryMemcacheMessage retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface BinaryMemcacheMessage

Specified by:

retain in interface MemcacheMessage

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

retain

public BinaryMemcacheMessage 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 MemcacheMessage

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class AbstractReferenceCounted

deallocate

protected void deallocate()

Description copied from class: AbstractReferenceCounted

Called once AbstractReferenceCounted.refCnt() is equals 0.

Specified by:

deallocate in class AbstractReferenceCounted

touch

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

Overrides:

touch in class AbstractReferenceCounted

touch

public BinaryMemcacheMessage touch(java.lang.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