BinaryMemcacheMessage (Netty API Reference (4.1.22.Final))

All Superinterfaces:

DecoderResultProvider ， MemcacheMessage ， MemcacheObject ， ReferenceCounted

All Known Subinterfaces:

BinaryMemcacheRequest ， BinaryMemcacheResponse ， FullBinaryMemcacheRequest ， FullBinaryMemcacheResponse

所有已知实现类：

AbstractBinaryMemcacheMessage ， DefaultBinaryMemcacheRequest ， DefaultBinaryMemcacheResponse ， DefaultFullBinaryMemcacheRequest ， DefaultFullBinaryMemcacheResponse
```
@UnstableApi
public interface BinaryMemcacheMessage
extends MemcacheMessage
```
定义二进制Memcache消息的接口，为BinaryMemcacheRequest和BinaryMemcacheResponse提供公共属性。
一个BinaryMemcacheMessage总是由一个头和可选的附加功能或/和一个键组成。

另请参见：

BinaryMemcacheRequest ， BinaryMemcacheResponse

方法摘要

所有方法接口方法抽象方法
Modifier and Type	Method and Description
`long`	`cas()` 返回CAS标识符。
`byte`	`dataType()` 返回消息的数据类型。
`ByteBuf`	`extras()` 返回可选附加项的`ByteBuf`表示形式。
`byte`	`extrasLength()` 返回消息的额外长度。
`ByteBuf`	`key()` 返回文档的可选键。
`short`	`keyLength()` 返回消息的密钥长度。
`byte`	`magic()` 返回消息的魔术字节。
`int`	`opaque()` 返回不透明值。
`byte`	`opcode()` 返回消息的操作码。
`BinaryMemcacheMessage`	`retain()` 将引用计数增加 `1` 。
`BinaryMemcacheMessage`	`retain(int increment)` 将参考计数增加 `increment` 。
`BinaryMemcacheMessage`	`setCas(long cas)` 设置CAS标识符。
`BinaryMemcacheMessage`	`setDataType(byte dataType)` 设置消息的数据类型。
`BinaryMemcacheMessage`	`setExtras(ByteBuf extras)` 设置消息上的额外缓冲区。
`BinaryMemcacheMessage`	`setKey(ByteBuf key)` 设置文档的关键字。
`BinaryMemcacheMessage`	`setMagic(byte magic)` 设置魔术字节。
`BinaryMemcacheMessage`	`setOpaque(int opaque)` 设置不透明值。
`BinaryMemcacheMessage`	`setOpcode(byte code)` 设置消息的操作码。
`BinaryMemcacheMessage`	`setTotalBodyLength(int totalBodyLength)` 设置总体长度。
`int`	`totalBodyLength()` 返回总体长度。
`BinaryMemcacheMessage`	`touch()` 记录此对象的当前访问位置以进行调试。
`BinaryMemcacheMessage`	`touch(java.lang.Object hint)` 记录此对象的当前访问位置，并附加一些用于调试的任意信息。

Methods inherited from interface io.netty.handler.codec.DecoderResultProvider
decoderResult, setDecoderResult

Methods inherited from interface io.netty.util.ReferenceCounted
refCnt, release, release

- 方法详细信息
  - magic
```
byte magic()
```
    返回消息的魔术字节。
    
    结果
    
    神奇的字节。
  - setMagic
```
BinaryMemcacheMessage setMagic(byte magic)
```
    设置魔术字节。
    
    参数
    
    magic - 使用的魔术字节。
    
    另请参见：
    
    for typesafe opcodes.
  - opcode
```
byte opcode()
```
    返回消息的操作码。
    
    结果
    
    操作码。
  - setOpcode
```
BinaryMemcacheMessage setOpcode(byte code)
```
    设置消息的操作码。
    
    参数
    
    code - 使用的操作码。
  - keyLength
```
short keyLength()
```
    返回消息的密钥长度。
    这可能会返回0，因为密钥是可选的。
    
    结果
    
    密钥长度。
  - extrasLength
```
byte extrasLength()
```
    返回消息的额外长度。
    这可能是0，因为额外内容是可选的。
    
    结果
    
    额外的长度。
  - dataType
```
byte dataType()
```
    返回消息的数据类型。
    
    结果
    
    消息的数据类型。
  - setDataType
```
BinaryMemcacheMessage setDataType(byte dataType)
```
    设置消息的数据类型。
    
    参数
    
    dataType - 消息的数据类型。
  - totalBodyLength
```
int totalBodyLength()
```
    返回总体长度。
    请注意，这可能是0，因为主体是可选的。
    
    结果
    
    总体长度。
  - setTotalBodyLength
```
BinaryMemcacheMessage setTotalBodyLength(int totalBodyLength)
```
    设置总体长度。
    请注意，这可能是0，因为体长是可选的。
    
    参数
    
    totalBodyLength - 总体长度。
  - opaque
```
int opaque()
```
    返回不透明值。
    
    结果
    
    不透明的价值。
  - setOpaque
```
BinaryMemcacheMessage setOpaque(int opaque)
```
    设置不透明值。
    
    参数
    
    opaque - 使用的不透明值。
  - cas
```
long cas()
```
    返回CAS标识符。
    
    结果
    
    CAS标识符。
  - setCas
```
BinaryMemcacheMessage setCas(long cas)
```
    设置CAS标识符。
    
    参数
    
    cas - 要使用的CAS标识符。
  - key
```
ByteBuf key()
```
    返回文档的可选键。
    
    结果
    
    文件的关键。
  - setKey
```
BinaryMemcacheMessage setKey(ByteBuf key)
```
    设置文档的关键字。 ReferenceCounted.release()的所有权key被转移到这个BinaryMemcacheMessage 。
    
    参数
    
    key - 消息的关键。 ReferenceCounted.release()所有权转移到此BinaryMemcacheMessage 。
  - extras
```
ByteBuf extras()
```
    返回可选附加项的ByteBuf表示形式。
    
    结果
    
    可选附加功能。
  - setExtras
```
BinaryMemcacheMessage setExtras(ByteBuf extras)
```
    设置消息上的额外缓冲区。 ReferenceCounted.release()的所有权extras被转移到这个BinaryMemcacheMessage 。
    
    参数
    
    extras - 文档的额外缓冲区。 ReferenceCounted.release()所有权转移到此BinaryMemcacheMessage 。
  - retain
```
BinaryMemcacheMessage retain()
```
    将引用计数增加 1 。
    
    Specified by:
    
    retain在界面 MemcacheMessage
    
    Specified by:
    
    retain接口 ReferenceCounted
  - retain
```
BinaryMemcacheMessage retain(int increment)
```
    按指定的 increment增加参考计数。
    
    Specified by:
    
    retain接口 MemcacheMessage
    
    Specified by:
    
    retain接口 ReferenceCounted
  - touch
```
BinaryMemcacheMessage touch()
```
    从界面： ReferenceCounted复制的描述
    
    记录此对象的当前访问位置以进行调试。如果确定此物体泄漏，通过此操作记录的信息将通过ResourceLeakDetector提供给您。此方法是touch(null)的快捷方式。
    
    Specified by:
    
    touch接口 MemcacheMessage
    
    Specified by:
    
    touch ，界面 ReferenceCounted
  - touch
```
BinaryMemcacheMessage touch(java.lang.Object hint)
```
    从接口复制的描述： ReferenceCounted
    
    记录此对象的当前访问位置，并附加一些用于调试的任意信息。如果确定此物体泄漏，则通过此操作记录的信息将通过ResourceLeakDetector提供给您。
    
    Specified by:
    
    touch接口 MemcacheMessage
    
    Specified by:
    
    touch在界面 ReferenceCounted

Interface BinaryMemcacheMessage

方法摘要

Methods inherited from interface io.netty.handler.codec.DecoderResultProvider

Methods inherited from interface 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