Class ExternalMessage

java.lang.Object

com.iohao.net.framework.protocol.AbstractCommunicationMessage

com.iohao.net.external.core.message.ExternalMessage

All Implemented Interfaces:

CommonResponse, CommunicationMessage, FutureMessage, RemoteMessage, Request, UserIdentity

@ProtobufClass
public final class ExternalMessage
extends AbstractCommunicationMessage

Default external transport message used between clients and the external server. Document

Author:

渔民小镇

date:

2023-02-21

Constructor Summary

Constructors

Constructor	Description
ExternalMessage()

Method Summary

Modifier and Type	Method	Description
int	getCmdCode()	Command type: 0 heartbeat, 1 business request.
int	getCmdMerge()	Merged route command (high 16 bits main cmd, low 16 bits sub cmd).
byte[]	getData()	Encoded business payload.
int	getErrorCode()	Response or error code, where 0 means success.
String	getErrorMessage()	Validation or failure details, usually an error/exception message.
int	getMsgId()	Client message identifier echoed back by the server response.
int	getProtocolSwitch()	Protocol-level feature switches, such as encryption or signature validation.
void	setCmdCode(int cmdCode)	Command type: 0 heartbeat, 1 business request.
void	setCmdMerge(int cmdMerge)	Merged route command (high 16 bits main cmd, low 16 bits sub cmd).
void	setData(byte[] data)	Encoded business payload.
void	setErrorCode(int errorCode)	Response or error code, where 0 means success.
void	setErrorMessage(String errorMessage)	Validation or failure details, usually an error/exception message.
void	setMsgId(int msgId)	Client message identifier echoed back by the server response.
void	setProtocolSwitch(int protocolSwitch)	Protocol-level feature switches, such as encryption or signature validation.
String	toString()

Methods inherited from class AbstractCommunicationMessage

getAttachment, getBindingLogicServerIds, getCacheCondition, getExternalServerId, getFutureId, getHopCount, getInetSocketAddress, getLogicServerId, getNanoTime, getNetId, getOther, getSourceServerId, getStick, getTraceId, getUserId, isVerifyIdentity, setAttachment, setBindingLogicServerIds, setCacheCondition, setCmdInfo, setExternalServerId, setFutureId, setHopCount, setInetSocketAddress, setLogicServerId, setNanoTime, setNetId, setOther, setOutputError, setSourceServerId, setStick, setTraceId, setUserId, setVerifyIdentity

Methods inherited from class Object

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

Methods inherited from interface CommonResponse

hasError, isSuccess, setError

Methods inherited from interface CommunicationMessage

getCmdInfo

Methods inherited from interface UserIdentity

bindingUserId, setUserIdentity, verifyIdentity

Constructor Details

ExternalMessage

public ExternalMessage()

Method Details

toString

public String toString()

Overrides:

toString in class Object

getCmdCode

public int getCmdCode()

Command type: 0 heartbeat, 1 business request.

Specified by:

getCmdCode in interface CommunicationMessage

Overrides:

getCmdCode in class AbstractCommunicationMessage

Returns:

the command code

getProtocolSwitch

public int getProtocolSwitch()

Protocol-level feature switches, such as encryption or signature validation.

Specified by:

getProtocolSwitch in interface CommunicationMessage

Overrides:

getProtocolSwitch in class AbstractCommunicationMessage

Returns:

the protocol switch bitmask

getCmdMerge

public int getCmdMerge()

Merged route command (high 16 bits main cmd, low 16 bits sub cmd).

Returns:

the merged command key

getErrorCode

public int getErrorCode()

Response or error code, where 0 means success.

Specified by:

getErrorCode in interface CommonResponse

Overrides:

getErrorCode in class AbstractCommunicationMessage

Returns:

the error code

getErrorMessage

public String getErrorMessage()

Validation or failure details, usually an error/exception message.

Specified by:

getErrorMessage in interface CommonResponse

Overrides:

getErrorMessage in class AbstractCommunicationMessage

Returns:

the error message, or null on success

getData

public byte[] getData()

Encoded business payload.

Returns:

the payload byte array

getMsgId

public int getMsgId()

Client message identifier echoed back by the server response.

Specified by:

getMsgId in interface CommunicationMessage

Overrides:

getMsgId in class AbstractCommunicationMessage

Returns:

the message ID

setCmdCode

public void setCmdCode(int cmdCode)

Command type: 0 heartbeat, 1 business request.

Specified by:

setCmdCode in interface CommunicationMessage

Overrides:

setCmdCode in class AbstractCommunicationMessage

Parameters:

cmdCode - the command code

setProtocolSwitch

public void setProtocolSwitch(int protocolSwitch)

Protocol-level feature switches, such as encryption or signature validation.

Specified by:

setProtocolSwitch in interface CommunicationMessage

Overrides:

setProtocolSwitch in class AbstractCommunicationMessage

Parameters:

protocolSwitch - the protocol switch bitmask

setCmdMerge

public void setCmdMerge(int cmdMerge)

Merged route command (high 16 bits main cmd, low 16 bits sub cmd).

Parameters:

cmdMerge - the merged command key

setErrorCode

public void setErrorCode(int errorCode)

Response or error code, where 0 means success.

Specified by:

setErrorCode in interface CommonResponse

Overrides:

setErrorCode in class AbstractCommunicationMessage

Parameters:

errorCode - the error code

setErrorMessage

public void setErrorMessage(String errorMessage)

Validation or failure details, usually an error/exception message.

Specified by:

setErrorMessage in interface CommonResponse

Overrides:

setErrorMessage in class AbstractCommunicationMessage

Parameters:

errorMessage - the error message

setData

public void setData(byte[] data)

Encoded business payload.

Parameters:

data - the payload byte array

setMsgId

public void setMsgId(int msgId)

Client message identifier echoed back by the server response.

Specified by:

setMsgId in interface CommunicationMessage

Overrides:

setMsgId in class AbstractCommunicationMessage

Parameters:

msgId - the message ID