BinaryMemcacheMessage (Netty 4.1.109.Final API文档

所有超级接口:

DecoderResultProvider, MemcacheMessage, MemcacheObject, ReferenceCounted

所有已知子接口:

BinaryMemcacheRequest, BinaryMemcacheResponse, FullBinaryMemcacheRequest, FullBinaryMemcacheResponse

所有已知实现类:

AbstractBinaryMemcacheMessage, DefaultBinaryMemcacheRequest, DefaultBinaryMemcacheResponse, DefaultFullBinaryMemcacheRequest, DefaultFullBinaryMemcacheResponse
```
@UnstableApi
public interface BinaryMemcacheMessage
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.

另请参阅:

BinaryMemcacheRequest, BinaryMemcacheResponse

方法概要

All Methods Instance Methods Abstract Methods
限定符和类型	方法和说明
`long`	`cas()` Returns the CAS identifier.
`byte`	`dataType()` Returns the data type of the message.
`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 code)` 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.

从接口继承的方法 io.netty.handler.codec.DecoderResultProvider
decoderResult, setDecoderResult

从接口继承的方法 io.netty.util.ReferenceCounted
refCnt, release, release

- 方法详细资料
  - magic
```
byte magic()
```
    Returns the magic byte for the message.
    
    返回:
    
    the magic byte.
  - setMagic
```
BinaryMemcacheMessage setMagic(byte magic)
```
    Sets the magic byte.
    
    参数:
    
    magic - the magic byte to use.
    
    另请参阅:
    
    for typesafe opcodes.
  - opcode
```
byte opcode()
```
    Returns the opcode for the message.
    
    返回:
    
    the opcode.
  - setOpcode
```
BinaryMemcacheMessage setOpcode(byte code)
```
    Sets the opcode for the message.
    
    参数:
    
    code - the opcode to use.
  - keyLength
```
short keyLength()
```
    Returns the key length of the message.
    This may return 0, since the key is optional.
    
    返回:
    
    the key length.
  - extrasLength
```
byte extrasLength()
```
    Return the extras length of the message.
    This may be 0, since the extras content is optional.
    
    返回:
    
    the extras length.
  - dataType
```
byte dataType()
```
    Returns the data type of the message.
    
    返回:
    
    the data type of the message.
  - setDataType
```
BinaryMemcacheMessage setDataType(byte dataType)
```
    Sets the data type of the message.
    
    参数:
    
    dataType - the data type of the message.
  - totalBodyLength
```
int totalBodyLength()
```
    Returns the total body length.
    Note that this may be 0, since the body is optional.
    
    返回:
    
    the total body length.
  - setTotalBodyLength
```
BinaryMemcacheMessage setTotalBodyLength(int totalBodyLength)
```
    Sets the total body length.
    Note that this may be 0, since the body length is optional.
    
    参数:
    
    totalBodyLength - the total body length.
  - opaque
```
int opaque()
```
    Returns the opaque value.
    
    返回:
    
    the opaque value.
  - setOpaque
```
BinaryMemcacheMessage setOpaque(int opaque)
```
    Sets the opaque value.
    
    参数:
    
    opaque - the opaque value to use.
  - cas
```
long cas()
```
    Returns the CAS identifier.
    
    返回:
    
    the CAS identifier.
  - setCas
```
BinaryMemcacheMessage setCas(long cas)
```
    Sets the CAS identifier.
    
    参数:
    
    cas - the CAS identifier to use.
  - key
```
ByteBuf key()
```
    Returns the optional key of the document.
    
    返回:
    
    the key of the document.
  - setKey
```
BinaryMemcacheMessage setKey(ByteBuf key)
```
    Sets the key of the document. ReferenceCounted.release() ownership of key is transferred to this BinaryMemcacheMessage.
    
    参数:
    
    key - the key of the message. ReferenceCounted.release() ownership is transferred to this BinaryMemcacheMessage.
  - extras
```
ByteBuf extras()
```
    Returns a ByteBuf representation of the optional extras.
    
    返回:
    
    the optional extras.
  - setExtras
```
BinaryMemcacheMessage setExtras(ByteBuf extras)
```
    Sets the extras buffer on the message. ReferenceCounted.release() ownership of extras is transferred to this BinaryMemcacheMessage.
    
    参数:
    
    extras - the extras buffer of the document. ReferenceCounted.release() ownership is transferred to this BinaryMemcacheMessage.
  - retain
```
BinaryMemcacheMessage retain()
```
    Increases the reference count by 1.
    
    指定者:
    
    retain 在接口中 MemcacheMessage
    
    指定者:
    
    retain 在接口中 ReferenceCounted
  - retain
```
BinaryMemcacheMessage retain(int increment)
```
    Increases the reference count by the specified increment.
    
    指定者:
    
    retain 在接口中 MemcacheMessage
    
    指定者:
    
    retain 在接口中 ReferenceCounted
  - touch
```
BinaryMemcacheMessage touch()
```
    从接口复制的说明: 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).
    
    指定者:
    
    touch 在接口中 MemcacheMessage
    
    指定者:
    
    touch 在接口中 ReferenceCounted
  - touch
```
BinaryMemcacheMessage touch(java.lang.Object hint)
```
    从接口复制的说明: 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.
    
    指定者:
    
    touch 在接口中 MemcacheMessage
    
    指定者:
    
    touch 在接口中 ReferenceCounted

接口 BinaryMemcacheMessage

方法概要

从接口继承的方法 io.netty.handler.codec.DecoderResultProvider

从接口继承的方法 io.netty.util.ReferenceCounted

方法详细资料

magic

setMagic

opcode

setOpcode

keyLength

extrasLength

dataType

setDataType

totalBodyLength

setTotalBodyLength

opaque

setOpaque

cas

setCas

key

setKey

extras

setExtras

retain

retain

touch

touch