io.netty.handler.codec.memcache.binary

Interface BinaryMemcacheMessageHeader

All Known Subinterfaces:

BinaryMemcacheRequestHeader, BinaryMemcacheResponseHeader

All Known Implementing Classes:

AbstractBinaryMemcacheMessageHeader, DefaultBinaryMemcacheRequestHeader, DefaultBinaryMemcacheResponseHeader

public interface BinaryMemcacheMessageHeader

Contains all common header fields in a BinaryMemcacheMessage.

Since the header is different for a BinaryMemcacheRequest and BinaryMemcacheResponse, see BinaryMemcacheRequestHeader and BinaryMemcacheResponseHeader.

The BinaryMemcacheMessageHeader is always 24 bytes in length and needs to be filled up if values are not set.

Fore more information, see the official protocol specification here.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCAS() Returns the CAS identifier.
byte	getDataType() Returns the data type of the message.
byte	getExtrasLength() Return the extras length of the message.
short	getKeyLength() Returns the key length of the message.
byte	getMagic() Returns the magic byte for the message.
int	getOpaque() Returns the opaque value.
byte	getOpcode() Returns the opcode for the message.
int	getTotalBodyLength() Returns the total body length.
BinaryMemcacheMessageHeader	setCAS(long cas) Sets the CAS identifier.
BinaryMemcacheMessageHeader	setDataType(byte dataType) Sets the data type of the message.
BinaryMemcacheMessageHeader	setExtrasLength(byte extrasLength) Set the extras length of the message.
BinaryMemcacheMessageHeader	setKeyLength(short keyLength) Set the key length of the message.
BinaryMemcacheMessageHeader	setMagic(byte magic) Sets the magic byte.
BinaryMemcacheMessageHeader	setOpaque(int opaque) Sets the opaque value.
BinaryMemcacheMessageHeader	setOpcode(byte code) Sets the opcode for the message.
BinaryMemcacheMessageHeader	setTotalBodyLength(int totalBodyLength) Sets the total body length.

Method Detail

getMagic

byte getMagic()

Returns the magic byte for the message.

Returns:

the magic byte.

setMagic

BinaryMemcacheMessageHeader setMagic(byte magic)

Sets the magic byte.

Parameters:

magic - the magic byte to use.

See Also:

for typesafe opcodes.

getOpcode

byte getOpcode()

Returns the opcode for the message.

Returns:

the opcode.

setOpcode

BinaryMemcacheMessageHeader setOpcode(byte code)

Sets the opcode for the message.

Parameters:

code - the opcode to use.

getKeyLength

short getKeyLength()

Returns the key length of the message.

This may return 0, since the key is optional.

Returns:

the key length.

setKeyLength

BinaryMemcacheMessageHeader setKeyLength(short keyLength)

Set the key length of the message.

This may be 0, since the key is optional.

Parameters:

keyLength - the key length to use.

getExtrasLength

byte getExtrasLength()

Return the extras length of the message.

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

Returns:

the extras length.

setExtrasLength

BinaryMemcacheMessageHeader setExtrasLength(byte extrasLength)

Set the extras length of the message.

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

Parameters:

extrasLength - the extras length.

getDataType

byte getDataType()

Returns the data type of the message.

Returns:

the data type of the message.

setDataType

BinaryMemcacheMessageHeader setDataType(byte dataType)

Sets the data type of the message.

Parameters:

dataType - the data type of the message.

getTotalBodyLength

int getTotalBodyLength()

Returns the total body length.

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

Returns:

the total body length.

setTotalBodyLength

BinaryMemcacheMessageHeader setTotalBodyLength(int totalBodyLength)

Sets the total body length.

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

Parameters:

totalBodyLength - the total body length.

getOpaque

int getOpaque()

Returns the opaque value.

Returns:

the opaque value.

setOpaque

BinaryMemcacheMessageHeader setOpaque(int opaque)

Sets the opaque value.

Parameters:

opaque - the opqaue value to use.

getCAS

long getCAS()

Returns the CAS identifier.

Returns:

the CAS identifier.

setCAS

BinaryMemcacheMessageHeader setCAS(long cas)

Sets the CAS identifier.

Parameters:

cas - the CAS identifier to use.