ESPlus消息格式.docxVIP

ESPlus消息格式一.消息编解码总体策略字符串一律使用UTF-8编码。如果是基础数据类型，则直接记录其字节。如果是string，先记录其长度(int，-1表示为null，0表示string.Empty)，再记录UTF8编码的字节。如果是byte[]，先记录其长度(int，-1表示为null)，再记录其内容。如果是List，先记录元素数(int，-1表示为null)，再依次记录每个元素的内容。如果是Dictionary,，先记录元素对的个数(int，-1表示为null)，再依次记录每个元素的Key,Value。如果是自定义的class和struct，则先记录其序列化的长度(int，-1表示为null)，再记录其序列化后的内容。二.消息头消息头固定长度为56，用户UserID的最大长度为21，MessageType取值为0~65535。字段名称类型起始偏移长度/最大长度说明StartTokenbyte01消息标识符，固定为0xFFClientTypebyte11客户端类型MessageTypeushort22消息类型MessageIDint44消息IDMessageBodyLenint84消息体长度UserIDLenbyte121UserID长度UserIDstring13UserIDLen /21消息发送者的IDDestUserIDLenbyte341DestUserID长度DestUserIDstring35DestUserIDLen /21消息接收者的IDClientType取值：DotNET = 0，Silverlight = 1， WindowsPhone = 2，Flash = 3 ，IOS = 4，Android = 5，其它=6。服务器有一个虚拟的UserID，即NetServer.SystemUserID，其值为“_0”。如果消息头中的UserID为SystemUserID，表示该消息是由服务器发出的；如果消息头中的DestUserID为SystemUserID，则表示该消息的接收者是服务器。在某些消息类型中，可以为消息头中的DestUserID赋值为某个GroupID，以表示广播消息的接收者是目标组中的所有人。三.ESPlus.Application.Basic命名空间消息体1.登录登录请求ReqLogonContract，C-S，MessageType为116。字段名称类型起始偏移长度说明BodyLenint04MessageBodyLen - 4PasswordLenint44密码长度Passwordstring8PasswordLen密码SystemTokenLenint8+ PasswordLen4系统标志长度SystemTokenstring12+ PasswordLenSystemTokenLen系统标志登录回复ResLogonContract，S-C，MessageType为116，MessageID使用登录请求消息头中的MessageID。字段名称类型起始偏移长度说明BodyLenint04MessageBodyLen - 4FailureCauseLenint44失败原因的长度FailureCausestring8FailureCauseLen失败原因LogonResultint8+ FailureCauseLen4登陆结果P2Pbool12+ FailureCauseLenLogonResult：0-Succeed，1-Failed，2-已在其它地方登录2.踢人踢人请求KickOutContract，C-S，MessageType为108。（客户端请求服务器将某用户踢出）字段名称类型起始偏移长度说明BodyLenint04MessageBodyLen - 4UserIDLenint44被踢用户ID的长度UserIDstring8UserIDLen被踢用户的ID3.获取自己IP地址请求C-S，MessageType为101。无消息体。回复UserIpeResContract，S-C，MessageType为101，MessageID使用请求消息头中的MessageID。字段名称类型起始偏移长度说明BodyLenint04MessageBodyLen - 4IPLenint44IP长度IPstring8IPLenIPPortint8+ IPLen4端口4.获取所有在线的用户列表请求C-S，MessageType为112。无消息体。回复ResUsersContract，S-C，MessageType为112，MessageID使用请求消息头中的MessageID。字段名称类型起始偏移长度说明BodyLenint04MessageBodyLen - 4UserCountint44在线用户列表长度U