RemotingCommand (schedulerX-client 2.1.5 API)

java.lang.Object
- com.alibaba.tmq.common.remoting.protocol.RemotingCommand

```
public class RemotingCommand
extends Object
```
Remoting模块中，服务器与客户端通过传递RemotingCommand来交互

从以下版本开始:

2013-7-13

作者:

shijia.wxr

字段概要

字段
限定符和类型字段和说明

static String RemotingVersionKey

字段
限定符和类型	字段和说明
`static String`	`RemotingVersionKey`

构造器概要

构造器
构造器和说明

RemotingCommand()

构造器
构造器和说明
`RemotingCommand()`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addExtField(String key, String value)`
`static int`	`createNewRequestId()`
`static RemotingCommand`	`createRequestCommand(int code, CommandCustomHeader customHeader)`
`static RemotingCommand`	`createResponseCommand(Class<? extends CommandCustomHeader> classHeader)`
`static RemotingCommand`	`createResponseCommand(int code, String remark)`
`static RemotingCommand`	`createResponseCommand(int code, String remark, Class<? extends CommandCustomHeader> classHeader)` 只有通信层内部会调用，业务不会调用
`static RemotingCommand`	`decode(byte[] array)`
`static RemotingCommand`	`decode(ByteBuffer byteBuffer)`
`static RemotingCommand`	`decodeBody(ByteBuffer byteBuffer)`
`CommandCustomHeader`	`decodeCommandCustomHeader(Class<? extends CommandCustomHeader> classHeader)`
`ByteBuffer`	`encode()`
`ByteBuffer`	`encodeHeader()`
`ByteBuffer`	`encodeHeader(int bodyLength)` 只打包Header，body部分独立传输
`byte[]`	`getBody()`
`int`	`getCode()`
`HashMap<String,String>`	`getExtFields()`
`int`	`getFlag()`
`LanguageCode`	`getLanguage()`
`int`	`getOpaque()`
`String`	`getRemark()`
`RemotingCommandType`	`getType()`
`int`	`getVersion()`
`boolean`	`isOnewayRPC()`
`boolean`	`isResponseType()`
`void`	`makeCustomHeaderToNet()`
`void`	`markOnewayRPC()`
`void`	`markResponseType()`
`CommandCustomHeader`	`readCustomHeader()`
`void`	`setBody(byte[] body)`
`void`	`setCode(int code)`
`void`	`setExtFields(HashMap<String,String> extFields)`
`void`	`setFlag(int flag)`
`void`	`setLanguage(LanguageCode language)`
`void`	`setOpaque(int opaque)`
`void`	`setRemark(String remark)`
`void`	`setVersion(int version)`
`String`	`toString()`
`void`	`writeCustomHeader(CommandCustomHeader customHeader)`

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

字段详细资料

RemotingVersionKey

public static String RemotingVersionKey

构造器详细资料
- RemotingCommand
```
public RemotingCommand()
```

方法详细资料

createRequestCommand

public static RemotingCommand createRequestCommand(int code,
                                                   CommandCustomHeader customHeader)

createResponseCommand

public static RemotingCommand createResponseCommand(Class<? extends CommandCustomHeader> classHeader)

createResponseCommand

public static RemotingCommand createResponseCommand(int code,
                                                    String remark)

createResponseCommand

public static RemotingCommand createResponseCommand(int code,
                                                    String remark,
                                                    Class<? extends CommandCustomHeader> classHeader)

只有通信层内部会调用，业务不会调用

makeCustomHeaderToNet
```
public void makeCustomHeaderToNet()
```

readCustomHeader

public CommandCustomHeader readCustomHeader()

writeCustomHeader

public void writeCustomHeader(CommandCustomHeader customHeader)

decodeCommandCustomHeader

public CommandCustomHeader decodeCommandCustomHeader(Class<? extends CommandCustomHeader> classHeader)
                                              throws RemotingCommandException

抛出:: RemotingCommandException

encode
```
public ByteBuffer encode()
```

encodeHeader
```
public ByteBuffer encodeHeader()
```

encodeHeader

public ByteBuffer encodeHeader(int bodyLength)

只打包Header，body部分独立传输

decode

public static RemotingCommand decode(byte[] array)

decode

public static RemotingCommand decode(ByteBuffer byteBuffer)

decodeBody

public static RemotingCommand decodeBody(ByteBuffer byteBuffer)

markResponseType
```
public void markResponseType()
```

isResponseType
```
public boolean isResponseType()
```

markOnewayRPC
```
public void markOnewayRPC()
```

isOnewayRPC
```
public boolean isOnewayRPC()
```

getCode
```
public int getCode()
```

setCode
```
public void setCode(int code)
```

getType
```
public RemotingCommandType getType()
```

getLanguage
```
public LanguageCode getLanguage()
```

setLanguage

public void setLanguage(LanguageCode language)

getVersion
```
public int getVersion()
```

setVersion
```
public void setVersion(int version)
```

getOpaque
```
public int getOpaque()
```

setOpaque
```
public void setOpaque(int opaque)
```

getFlag
```
public int getFlag()
```

setFlag
```
public void setFlag(int flag)
```

getRemark
```
public String getRemark()
```

setRemark
```
public void setRemark(String remark)
```

getBody
```
public byte[] getBody()
```

setBody
```
public void setBody(byte[] body)
```

getExtFields

public HashMap<String,String> getExtFields()

setExtFields

public void setExtFields(HashMap<String,String> extFields)

createNewRequestId

public static int createNewRequestId()

addExtField

public void addExtField(String key,
                        String value)

toString
```
public String toString()
```
覆盖:

toString 在类中 Object

类 RemotingCommand

字段概要

构造器概要

方法概要

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

字段详细资料

RemotingVersionKey

构造器详细资料

RemotingCommand

方法详细资料

createRequestCommand

createResponseCommand

createResponseCommand

createResponseCommand

makeCustomHeaderToNet

readCustomHeader

writeCustomHeader

decodeCommandCustomHeader

encode

encodeHeader

encodeHeader

decode

decode

decodeBody

markResponseType

isResponseType

markOnewayRPC

isOnewayRPC

getCode

setCode

getType

getLanguage

setLanguage

getVersion

setVersion

getOpaque

setOpaque

getFlag

setFlag

getRemark

setRemark

getBody

setBody

getExtFields

setExtFields

createNewRequestId

addExtField

toString