io.netty.handler.codec.memcache.binary

Class AbstractBinaryMemcacheMessageHeader

java.lang.Object

io.netty.handler.codec.memcache.binary.AbstractBinaryMemcacheMessageHeader

All Implemented Interfaces:

BinaryMemcacheMessageHeader

Direct Known Subclasses:

DefaultBinaryMemcacheRequestHeader, DefaultBinaryMemcacheResponseHeader

public abstract class AbstractBinaryMemcacheMessageHeader
extends Object
implements BinaryMemcacheMessageHeader

The default implementation of a BinaryMemcacheMessageHeader.

Constructor Summary

Constructors

Constructor and Description
AbstractBinaryMemcacheMessageHeader()

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 opcode) Sets the opcode for the message.
BinaryMemcacheMessageHeader	setTotalBodyLength(int totalBodyLength) Sets the total body length.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBinaryMemcacheMessageHeader

public AbstractBinaryMemcacheMessageHeader()

Method Detail

getMagic

public byte getMagic()

Description copied from interface: BinaryMemcacheMessageHeader

Returns the magic byte for the message.

Specified by:

getMagic in interface BinaryMemcacheMessageHeader

Returns:

the magic byte.

setMagic

public BinaryMemcacheMessageHeader setMagic(byte magic)

Description copied from interface: BinaryMemcacheMessageHeader

Sets the magic byte.

Specified by:

setMagic in interface BinaryMemcacheMessageHeader

Parameters:

magic - the magic byte to use.

See Also:

for typesafe opcodes.

getCAS

public long getCAS()

Description copied from interface: BinaryMemcacheMessageHeader

Returns the CAS identifier.

Specified by:

getCAS in interface BinaryMemcacheMessageHeader

Returns:

the CAS identifier.

setCAS

public BinaryMemcacheMessageHeader setCAS(long cas)

Description copied from interface: BinaryMemcacheMessageHeader

Sets the CAS identifier.

Specified by:

setCAS in interface BinaryMemcacheMessageHeader

Parameters:

cas - the CAS identifier to use.

getOpaque

public int getOpaque()

Description copied from interface: BinaryMemcacheMessageHeader

Returns the opaque value.

Specified by:

getOpaque in interface BinaryMemcacheMessageHeader

Returns:

the opaque value.

setOpaque

public BinaryMemcacheMessageHeader setOpaque(int opaque)

Description copied from interface: BinaryMemcacheMessageHeader

Sets the opaque value.

Specified by:

setOpaque in interface BinaryMemcacheMessageHeader

Parameters:

opaque - the opqaue value to use.

getTotalBodyLength

public int getTotalBodyLength()

Description copied from interface: BinaryMemcacheMessageHeader

Returns the total body length.

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

Specified by:

getTotalBodyLength in interface BinaryMemcacheMessageHeader

Returns:

the total body length.

setTotalBodyLength

public BinaryMemcacheMessageHeader setTotalBodyLength(int totalBodyLength)

Description copied from interface: BinaryMemcacheMessageHeader

Sets the total body length.

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

Specified by:

setTotalBodyLength in interface BinaryMemcacheMessageHeader

Parameters:

totalBodyLength - the total body length.

getDataType

public byte getDataType()

Description copied from interface: BinaryMemcacheMessageHeader

Returns the data type of the message.

Specified by:

getDataType in interface BinaryMemcacheMessageHeader

Returns:

the data type of the message.

setDataType

public BinaryMemcacheMessageHeader setDataType(byte dataType)

Description copied from interface: BinaryMemcacheMessageHeader

Sets the data type of the message.

Specified by:

setDataType in interface BinaryMemcacheMessageHeader

Parameters:

dataType - the data type of the message.

getExtrasLength

public byte getExtrasLength()

Description copied from interface: BinaryMemcacheMessageHeader

Return the extras length of the message.

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

Specified by:

getExtrasLength in interface BinaryMemcacheMessageHeader

Returns:

the extras length.

setExtrasLength

public BinaryMemcacheMessageHeader setExtrasLength(byte extrasLength)

Description copied from interface: BinaryMemcacheMessageHeader

Set the extras length of the message.

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

Specified by:

setExtrasLength in interface BinaryMemcacheMessageHeader

Parameters:

extrasLength - the extras length.

getKeyLength

public short getKeyLength()

Description copied from interface: BinaryMemcacheMessageHeader

Returns the key length of the message.

This may return 0, since the key is optional.

Specified by:

getKeyLength in interface BinaryMemcacheMessageHeader

Returns:

the key length.

setKeyLength

public BinaryMemcacheMessageHeader setKeyLength(short keyLength)

Description copied from interface: BinaryMemcacheMessageHeader

Set the key length of the message.

This may be 0, since the key is optional.

Specified by:

setKeyLength in interface BinaryMemcacheMessageHeader

Parameters:

keyLength - the key length to use.

getOpcode

public byte getOpcode()

Description copied from interface: BinaryMemcacheMessageHeader

Returns the opcode for the message.

Specified by:

getOpcode in interface BinaryMemcacheMessageHeader

Returns:

the opcode.

setOpcode

public BinaryMemcacheMessageHeader setOpcode(byte opcode)

Description copied from interface: BinaryMemcacheMessageHeader

Sets the opcode for the message.

Specified by:

setOpcode in interface BinaryMemcacheMessageHeader

Parameters:

opcode - the opcode to use.