Protocal (MobileIMSDK 6.5(Server端) API文档)

java.lang.Object
- net.x52im.mobileimsdk.server.protocal.Protocal

```
public class Protocal
extends java.lang.Object
```
协议报文对象.

版本:

1.0

作者:

Jack Jiang( http://www.52im.net/thread-2792-1-1.html )

另请参阅:

ProtocalType

字段概要

字段
限定符和类型	字段和说明
`protected boolean`	`bridge` 意义：是否来自跨服务器的消息，true表示是、否则不是。
`protected java.lang.String`	`dataContent` 意义：协议数据内容。
`protected java.lang.String`	`fp` 意义：用于QoS消息包的质量保证时作为消息的指纹特征码（理论上全局唯一）。
`protected java.lang.String`	`from` 意义：消息发出方的id 说明：为“-1”表示未设定、为“0”表示来自Server。
`protected boolean`	`QoS` 意义：true表示本包需要进行QoS质量保证，否则不需要.
`protected int`	`retryCount` 本字段仅用于客户端QoS时：表示丢包重试次数
`protected long`	`sm` 服务端发出或转发此消息时的时间（此字段仅在 `ServerLauncher.serverTimestamp == true` 时被服务端自动设置）。
`protected java.lang.String`	`to` 意义：消息接收方的id（当用户退出时，此值可不设置）说明：为“-1”表示未设定、为“0”表示发给Server。
`protected int`	`type` 意义：协议类型。
`protected int`	`typeu` 意义：应用层专用字段——用于应用层存放聊天、推送等场景下的消息类型。

构造器概要

构造器
构造器和说明
`Protocal(int type, java.lang.String dataContent, java.lang.String from, java.lang.String to)` 构造方法（QoS标记默认为false、typeu字段默认为-1）。
`Protocal(int type, java.lang.String dataContent, java.lang.String from, java.lang.String to, boolean QoS, java.lang.String fingerPrint)` 构造方法（typeu字段默认为-1）。
`Protocal(int type, java.lang.String dataContent, java.lang.String from, java.lang.String to, boolean QoS, java.lang.String fingerPrint, int typeu)` 构造方法。
`Protocal(int type, java.lang.String dataContent, java.lang.String from, java.lang.String to, int typeu)` 构造方法（QoS标记默认为false）。

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`java.lang.Object`	`clone()` Protocal深度对象克隆方法实现。
`static java.lang.String`	`genFingerPrint()` 返回QoS需要的消息包的指纹特征码.
`static long`	`genServerTimestamp()` 返回服务端时间戳。
`java.lang.String`	`getDataContent()` 返回协议数据内容。
`java.lang.String`	`getFp()` 返回QoS质量保证时的指统特征码.
`java.lang.String`	`getFrom()` 返回消息发出方的id。
`int`	`getRetryCount()` 本字段仅用于QoS时：表示丢包重试次数。
`long`	`getSm()`
`java.lang.String`	`getTo()` 返回消息接收方的id。
`int`	`getType()` 返回协议类型.
`int`	`getTypeu()` 返回应用层专用字段——用于应用层存放聊天、推送等场景下的消息类型。
`void`	`increaseRetryCount()` 本方法仅用于QoS时：选出包重试次数+1。
`boolean`	`isBridge()` 是否来自跨服务器的消息，true表示是、否则不是。
`boolean`	`isQoS()` 是否需QoS支持。
`void`	`setBridge(boolean bridge)`
`void`	`setDataContent(java.lang.String dataContent)` 设置协议数据内容。
`void`	`setFrom(java.lang.String from)` 设置消息发出方的id（当用户登陆时，此值可不设置）。
`void`	`setQoS(boolean qoS)`
`void`	`setSm(long sm)`
`void`	`setTo(java.lang.String to)` 消息接收方的id（当用户退出时，此值可不设置）。
`void`	`setType(int type)` 设置协议类型.
`void`	`setTypeu(int typeu)` 设置应用层专用字段——用于应用层存放聊天、推送等场景下的消息类型。
`byte[]`	`toBytes()` 将本对象转换成JSON后再转换成byte数组.
`java.lang.String`	`toGsonString()` 将本对象转换成JSON字符串.

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

- 字段详细资料
  - bridge
```
protected boolean bridge
```
    意义：是否来自跨服务器的消息，true表示是、否则不是。本字段是为跨服务器或集群准备的。
    默认：false
    
    从以下版本开始:
    
    3.0
  - type
```
protected int type
```
    意义：协议类型。
    注意：本字段为框架专用字段，本字段的使用涉及IM核心层算法的表现，如无必要请避免应用层使用此字段。
    补充：理论上应用层不参与本字段的定义，可将其视为透明，如需定义应用层的消息类型，请使用 typeu 字段并配合dataContent一起使用。
    默认：0
    
    另请参阅:
    
    ProtocalType
  - dataContent
```
protected java.lang.String dataContent
```
    意义：协议数据内容。
    说明：本字段用于MobileIMSDK框架中时，可能会存放一些指令内容。当本字段用于应用层时，由用户自行定义和使用其内容。
  - from
```
protected java.lang.String from
```
    意义：消息发出方的id
    说明：为“-1”表示未设定、为“0”表示来自Server。
    默认："-1"
  - to
```
protected java.lang.String to
```
    意义：消息接收方的id（当用户退出时，此值可不设置）
    说明：为“-1”表示未设定、为“0”表示发给Server。
    默认："-1"
  - fp
```
protected java.lang.String fp
```
    意义：用于QoS消息包的质量保证时作为消息的指纹特征码（理论上全局唯一）。
    注意：本字段为框架专用字段，请勿用作其它用途。
  - QoS
```
protected boolean QoS
```
    意义：true表示本包需要进行QoS质量保证，否则不需要.
    默认：false
  - typeu
```
protected int typeu
```
    意义：应用层专用字段——用于应用层存放聊天、推送等场景下的消息类型。
    注意：此值为-1时表示未定义。MobileIMSDK框架中，本字段为保留字段，不参与框架的核心算法，专留用应用层自行定义和使用。
    默认：-1
    
    从以下版本开始:
    
    3.0, at 20161021
  - retryCount
```
protected transient int retryCount
```
    本字段仅用于客户端QoS时：表示丢包重试次数
  - sm
```
protected long sm
```
    服务端发出或转发此消息时的时间（此字段仅在 ServerLauncher.serverTimestamp == true 时被服务端自动设置）。
    此时间为形如“1624333553769”的Java时间戳，此值不设置则默认为-1。
    本段的用途：本字段不参与MobileIMSDK核心框架的任何算法，本字段的存与否与框架算法无任何关系，仅仅提供给应用层供开发者使用，开发者可以利用此字段来构造消息的排序逻辑等，别无他用。
    
    从以下版本开始:
    
    6.0
- 构造器详细资料
  - Protocal
```
public Protocal(int type,
                java.lang.String dataContent,
                java.lang.String from,
                java.lang.String to)
```
    构造方法（QoS标记默认为false、typeu字段默认为-1）。
    
    参数:
    
    type - 协议类型
    
    dataContent - 协议数据内容
    
    from - 消息发出方的id（当用户登陆时，此值可不设置）
    
    to - 消息接收方的id（当用户退出时，此值可不设备）
    
    另请参阅:
    
    Protocal(int, String, String, String, int)
  - Protocal
```
public Protocal(int type,
                java.lang.String dataContent,
                java.lang.String from,
                java.lang.String to,
                int typeu)
```
    构造方法（QoS标记默认为false）。
    
    参数:
    
    type - 协议类型
    
    dataContent - 协议数据内容
    
    from - 消息发出方的id（当用户登陆时，此值可不设置）
    
    to - 消息接收方的id（当用户退出时，此值可不设备）
    
    typeu - 应用层专用字段——用于应用层存放聊天、推送等场景下的消息类型，不需要设置时请填-1即可
    
    另请参阅:
    
    Protocal(int, String, String, String, boolean, String, int)
  - Protocal
```
public Protocal(int type,
                java.lang.String dataContent,
                java.lang.String from,
                java.lang.String to,
                boolean QoS,
                java.lang.String fingerPrint)
```
    构造方法（typeu字段默认为-1）。
    
    参数:
    
    type - 协议类型
    
    dataContent - 协议数据内容
    
    from - 消息发出方的id（当用户登陆时，此值可不设置）
    
    to - 消息接收方的id（当用户退出时，此值可不设置）
    
    QoS - 是否需要QoS支持，true表示是，否则不需要
    
    fingerPrint - 协议包的指纹特征码，当 QoS字段=true时且本字段为null时方法中将自动生成指纹码否则使用本参数指定的指纹码
    
    另请参阅:
    
    Protocal(int, String, String, String, boolean, String, int)
  - Protocal
```
public Protocal(int type,
                java.lang.String dataContent,
                java.lang.String from,
                java.lang.String to,
                boolean QoS,
                java.lang.String fingerPrint,
                int typeu)
```
    构造方法。
    
    参数:
    
    type - 协议类型
    
    dataContent - 协议数据内容
    
    from - 消息发出方的id（当用户登陆时，此值可不设置）
    
    to - 消息接收方的id（当用户退出时，此值可不设置）
    
    QoS - 是否需要QoS支持，true表示是，否则不需要
    
    fingerPrint - 协议包的指纹特征码，当 QoS字段=true时且本字段为null时方法中将自动生成指纹码否则使用本参数指定的指纹码
    
    typeu - 应用层专用字段——用于应用层存放聊天、推送等场景下的消息类型，不需要设置时请填-1即可
- 方法详细资料
  - getType
```
public int getType()
```
    返回协议类型.
    
    返回:
    
    另请参阅:
    
    ProtocalType
  - setType
```
public void setType(int type)
```
    设置协议类型.
    
    参数:
    
    type - 协议类型
    
    另请参阅:
    
    ProtocalType
  - getDataContent
```
public java.lang.String getDataContent()
```
    返回协议数据内容。
    
    返回:
  - setDataContent
```
public void setDataContent(java.lang.String dataContent)
```
    设置协议数据内容。
    
    参数:
    
    dataContent -
  - getFrom
```
public java.lang.String getFrom()
```
    返回消息发出方的id。
    
    返回:
  - setFrom
```
public void setFrom(java.lang.String from)
```
    设置消息发出方的id（当用户登陆时，此值可不设置）。
    
    参数:
    
    from -
  - getTo
```
public java.lang.String getTo()
```
    返回消息接收方的id。
    
    返回:
  - setTo
```
public void setTo(java.lang.String to)
```
    消息接收方的id（当用户退出时，此值可不设置）。
    
    参数:
    
    to -
  - getFp
```
public java.lang.String getFp()
```
    返回QoS质量保证时的指统特征码.
    
    返回:
    
    另请参阅:
    
    genFingerPrint()
  - getRetryCount
```
public int getRetryCount()
```
    本字段仅用于QoS时：表示丢包重试次数。
    本值是transient类型，对象序列化时将会忽略此字段。
    
    返回:
  - increaseRetryCount
```
public void increaseRetryCount()
```
    本方法仅用于QoS时：选出包重试次数+1。
    本方法理论上由MobileIMSDK内部调用，应用层无需额外调用。
  - isQoS
```
public boolean isQoS()
```
    是否需QoS支持。
    
    返回:
    
    true表示是，否则不是
  - setQoS
```
public void setQoS(boolean qoS)
```
  - isBridge
```
public boolean isBridge()
```
    是否来自跨服务器的消息，true表示是、否则不是。本字段是为跨服务器或集群准备的。默认：false。
    
    返回:
    
    从以下版本开始:
    
    3.0
  - setBridge
```
public void setBridge(boolean bridge)
```
  - getTypeu
```
public int getTypeu()
```
    返回应用层专用字段——用于应用层存放聊天、推送等场景下的消息类型。
    注意：此值为-1时表示未定义。MobileIMSDK框架中，本字段为保留字段，不参与框架的核心算法，专留用应用层自行定义和使用。
    默认：-1。
    
    返回:
    
    任意应用层决定的整数
    
    从以下版本开始:
    
    3.0
  - setTypeu
```
public void setTypeu(int typeu)
```
    设置应用层专用字段——用于应用层存放聊天、推送等场景下的消息类型。
    注意：此值为-1时表示未定义。MobileIMSDK框架中，本字段为保留字段，不参与框架的核心算法，专留用应用层自行定义和使用。
    默认：-1。
    
    参数:
    
    typeu - 任意应用层决定的整数，如不使用请填-1
    
    从以下版本开始:
    
    3.0
  - getSm
```
public long getSm()
```
  - setSm
```
public void setSm(long sm)
```
  - toGsonString
```
public java.lang.String toGsonString()
```
    将本对象转换成JSON字符串.
    
    返回:
  - toBytes
```
public byte[] toBytes()
```
    将本对象转换成JSON后再转换成byte数组.
    
    返回:
    
    另请参阅:
    
    toGsonString()
  - clone
```
public java.lang.Object clone()
```
    Protocal深度对象克隆方法实现。
    
    覆盖:
    
    clone 在类中 java.lang.Object
    
    返回:
    
    克隆完成后的新对象
  - genServerTimestamp
```
public static long genServerTimestamp()
```
    返回服务端时间戳。
    
    返回:
  - genFingerPrint
```
public static java.lang.String genFingerPrint()
```
    返回QoS需要的消息包的指纹特征码.
    重要说明：使用系统时间戳作为指纹码，则意味着只在Protocal生成的环境中可能唯一. 它存在重复的可能性有2种：
    - 1) 比如在客户端生成时如果生成过快的话（时间戳最小单位是1毫秒，如1毫秒内生成多个指纹码），理论上是有重复可能性；
    - 2) 不同的客户端因为系统时间并不完全一致，理论上也是可能存在重复的，所以唯一性应是：好友+指纹码才对.
    目前使用的UUID能保证全局唯一，但它有36位长（加上分隔符32+4），在流量敏感的场景下，建议可考虑适当优化此生成算法。
    返回:
    
    指纹特征码
    
    另请参阅:
    
    UUID.randomUUID().toString()

类 Protocal

字段概要

构造器概要

方法概要

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

字段详细资料

bridge

type

dataContent

from

to

fp

QoS

typeu

retryCount

sm

构造器详细资料

Protocal

Protocal

Protocal

Protocal

方法详细资料

getType

setType

getDataContent

setDataContent

getFrom

setFrom

getTo

setTo

getFp

getRetryCount

increaseRetryCount

isQoS

setQoS

isBridge

setBridge

getTypeu

setTypeu

getSm

setSm

toGsonString

toBytes

clone

genServerTimestamp

genFingerPrint