io.netty.handler.codec.memcache.binary

Class AbstractBinaryMemcacheMessage<H extends BinaryMemcacheMessageHeader>

java.lang.Object

io.netty.handler.codec.memcache.AbstractMemcacheObject

io.netty.handler.codec.memcache.binary.AbstractBinaryMemcacheMessage<H>

All Implemented Interfaces:

BinaryMemcacheMessage<H>, MemcacheMessage, MemcacheObject, ReferenceCounted

Direct Known Subclasses:

DefaultBinaryMemcacheRequest, DefaultBinaryMemcacheResponse

public abstract class AbstractBinaryMemcacheMessage<H extends BinaryMemcacheMessageHeader>
extends AbstractMemcacheObject
implements BinaryMemcacheMessage<H>

Default implementation of a BinaryMemcacheMessage.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuf	getExtras() Returns a ByteBuf representation of the optional extras.
H	getHeader() Returns the BinaryMemcacheMessageHeader which contains the full required header.
String	getKey() Returns the optional key of the document.
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.
BinaryMemcacheMessage<H>	retain() Increases the reference count by 1.
BinaryMemcacheMessage<H>	retain(int increment) Increases the reference count by the specified increment.

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

getDecoderResult, setDecoderResult

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.memcache.MemcacheObject

getDecoderResult, setDecoderResult

Constructor Detail

AbstractBinaryMemcacheMessage

protected AbstractBinaryMemcacheMessage(H header,
                             String key,
                             ByteBuf extras)

Create a new instance with all properties set.

Parameters:

header - the message header.

key - the message key.

extras - the message extras.

Method Detail

getHeader

public H getHeader()

Description copied from interface: BinaryMemcacheMessage

Returns the BinaryMemcacheMessageHeader which contains the full required header.

Specified by:

getHeader in interface BinaryMemcacheMessage<H extends BinaryMemcacheMessageHeader>

Returns:

the required header.

getKey

public String getKey()

Description copied from interface: BinaryMemcacheMessage

Returns the optional key of the document.

Specified by:

getKey in interface BinaryMemcacheMessage<H extends BinaryMemcacheMessageHeader>

Returns:

the key of the document.

getExtras

public ByteBuf getExtras()

Description copied from interface: BinaryMemcacheMessage

Returns a ByteBuf representation of the optional extras.

Specified by:

getExtras in interface BinaryMemcacheMessage<H extends BinaryMemcacheMessageHeader>

Returns:

the optional extras.

refCnt

public int refCnt()

Description copied from interface: ReferenceCounted

Returns the reference count of this object. If 0, it means this object has been deallocated.

Specified by:

refCnt in interface ReferenceCounted

retain

public BinaryMemcacheMessage<H> retain()

Description copied from interface: BinaryMemcacheMessage

Increases the reference count by 1.

Specified by:

retain in interface BinaryMemcacheMessage<H extends BinaryMemcacheMessageHeader>

Specified by:

retain in interface MemcacheMessage

Specified by:

retain in interface ReferenceCounted

retain

public BinaryMemcacheMessage<H> retain(int increment)

Description copied from interface: BinaryMemcacheMessage

Increases the reference count by the specified increment.

Specified by:

retain in interface BinaryMemcacheMessage<H extends BinaryMemcacheMessageHeader>

Specified by:

retain in interface MemcacheMessage

Specified by:

retain in interface ReferenceCounted

release

public boolean release()

Description copied from interface: ReferenceCounted

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

release

public boolean release(int decrement)

Description copied from interface: ReferenceCounted

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated