AbstractBinaryMemcacheMessage (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.util.AbstractReferenceCounted
- - io.netty.handler.codec.memcache.AbstractMemcacheObject
  - - io.netty.handler.codec.memcache.binary.AbstractBinaryMemcacheMessage

所有已实现的接口:

DecoderResultProvider, BinaryMemcacheMessage, MemcacheMessage, MemcacheObject, ReferenceCounted

直接已知子类:

DefaultBinaryMemcacheRequest, DefaultBinaryMemcacheResponse
```
@UnstableApi
public abstract class AbstractBinaryMemcacheMessage
extends AbstractMemcacheObject
implements BinaryMemcacheMessage
```
Default implementation of a BinaryMemcacheMessage.

构造器概要

构造器
限定符构造器和说明

protected AbstractBinaryMemcacheMessage(ByteBuf key, ByteBuf extras)
Create a new instance with all properties set.

构造器
限定符	构造器和说明
`protected`	`AbstractBinaryMemcacheMessage(ByteBuf key, ByteBuf extras)` Create a new instance with all properties set.

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`long`	`cas()` Returns the CAS identifier.
`byte`	`dataType()` Returns the data type of the message.
`protected void`	`deallocate()` Called once `AbstractReferenceCounted.refCnt()` is equals 0.
`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 opcode)` 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.memcache.AbstractMemcacheObject
decoderResult, setDecoderResult

从类继承的方法 io.netty.util.AbstractReferenceCounted
refCnt, release, release, setRefCnt

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

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

类 AbstractBinaryMemcacheMessage

构造器概要

方法概要

从类继承的方法 io.netty.handler.codec.memcache.AbstractMemcacheObject

从类继承的方法 io.netty.util.AbstractReferenceCounted

从类继承的方法 java.lang.Object

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

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

构造器详细资料

AbstractBinaryMemcacheMessage

方法详细资料

key

extras

setKey

setExtras

magic

setMagic

cas

setCas

opaque

setOpaque

totalBodyLength

setTotalBodyLength

dataType

setDataType

extrasLength

keyLength

opcode

setOpcode

retain

retain

deallocate

touch

touch