io.netty.handler.codec.memcache.binary

Interface BinaryMemcacheMessage<H extends BinaryMemcacheMessageHeader>

All Superinterfaces:

MemcacheMessage, MemcacheObject, ReferenceCounted

All Known Subinterfaces:

BinaryMemcacheRequest, BinaryMemcacheResponse, FullBinaryMemcacheRequest, FullBinaryMemcacheResponse

All Known Implementing Classes:

AbstractBinaryMemcacheMessage, DefaultBinaryMemcacheRequest, DefaultBinaryMemcacheResponse, DefaultFullBinaryMemcacheRequest, DefaultFullBinaryMemcacheResponse

public interface BinaryMemcacheMessage<H extends BinaryMemcacheMessageHeader>
extends MemcacheMessage

An interface that defines a binary Memcache message, providing common properties for BinaryMemcacheRequest and BinaryMemcacheResponse.

A BinaryMemcacheMessage always consists of a header and optional extras or/and a key.

See Also:

BinaryMemcacheMessageHeader, BinaryMemcacheRequest, BinaryMemcacheResponse

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.
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 interface io.netty.handler.codec.memcache.MemcacheObject

getDecoderResult, setDecoderResult

Methods inherited from interface io.netty.util.ReferenceCounted

refCnt, release, release

Method Detail

getHeader

H getHeader()

Returns the BinaryMemcacheMessageHeader which contains the full required header.

Returns:

the required header.

getKey

String getKey()

Returns the optional key of the document.

Returns:

the key of the document.

getExtras

ByteBuf getExtras()

Returns a ByteBuf representation of the optional extras.

Returns:

the optional extras.

retain

BinaryMemcacheMessage<H> retain()

Increases the reference count by 1.

Specified by:

retain in interface MemcacheMessage

Specified by:

retain in interface ReferenceCounted

retain

BinaryMemcacheMessage<H> retain(int increment)

Increases the reference count by the specified increment.

Specified by:

retain in interface MemcacheMessage

Specified by:

retain in interface ReferenceCounted