366 lines
8.1 KiB
Protocol Buffer
366 lines
8.1 KiB
Protocol Buffer
package cs;
|
||
|
||
//常量
|
||
enum Constant_e
|
||
{
|
||
ProtoVersion = 2020061101; //协议版本
|
||
}
|
||
|
||
//心跳(每60秒上报)
|
||
message CMPing
|
||
{
|
||
}
|
||
message SMPing
|
||
{
|
||
optional int32 param1 = 1;
|
||
}
|
||
|
||
//分页信息
|
||
message MFPaging
|
||
{
|
||
optional int64 curr_page = 1; //当前页(第一页是0)
|
||
optional int32 page_size = 2; //每页记录数
|
||
optional int32 total_page = 3; //总页数(服务器填充该字段)
|
||
}
|
||
|
||
//用户基础数据(可用于缓存,除下划线开头的字段会存储到db)
|
||
message MFBaseUserData
|
||
{
|
||
optional string account_id = 1; //账号id
|
||
optional string nickname = 2; //昵称
|
||
optional string avatar_url = 3; //头像
|
||
optional int32 sex = 4; //性别 1:男 2:女 0:未知
|
||
optional int32 last_login_time = 5; //最后登录时间
|
||
|
||
optional int64 user_value1 = 50; //用户字段1
|
||
optional int64 user_value2 = 51; //用户字段2
|
||
optional int64 user_value3 = 52; //用户字段3
|
||
optional int64 base_data_version = 100; //数据版本号
|
||
|
||
optional int32 _online = 101; //是否在线
|
||
}
|
||
|
||
//临时用户自定义数据(不会存储每次上/下线时时都重置为0)
|
||
message MFUserTempCustomData
|
||
{
|
||
optional int64 value1 = 1 [default = 0]; //自定义字段1
|
||
optional int64 value2 = 2 [default = 0]; //自定义字段2
|
||
optional int64 value3 = 3 [default = 0]; //自定义字段3
|
||
}
|
||
|
||
//用户信息
|
||
message MFUserInfo
|
||
{
|
||
optional MFBaseUserData base_data = 1; //基础数据
|
||
optional MFUserTempCustomData temp_custom_data = 2; //临时用户自定义数据
|
||
}
|
||
|
||
//好友申请
|
||
message MFFriendApply
|
||
{
|
||
optional int64 idx = 1; //唯一索引id
|
||
optional int64 applyid = 2; //applyid
|
||
optional string target_id = 3; //target_id
|
||
optional MFBaseUserData base_data = 4; //基础数据
|
||
}
|
||
|
||
//登录好友服
|
||
message CMLogin
|
||
{
|
||
optional string account_id = 3; //账号id
|
||
optional string session_id = 20; //sessionid
|
||
optional string nickname = 4; //昵称
|
||
optional string avatar_url = 5; //头像
|
||
optional int32 sex = 6; //性别
|
||
}
|
||
//登录回复
|
||
message SMLogin
|
||
{
|
||
optional int32 errcode = 1; //错误码
|
||
optional string errmsg = 2; //错误信息
|
||
}
|
||
|
||
//更新用户信息(增量更新,不需更新的字段不传即可)
|
||
message CMUpdateUserInfo
|
||
{
|
||
optional string nickname = 2; //昵称
|
||
optional string avatar_url = 3; //头像
|
||
optional int32 sex = 4; //性别 1:男 2:女 0:未知
|
||
|
||
optional int64 user_value1 = 50; //用户字段1
|
||
optional int64 user_value2 = 51; //用户字段2
|
||
optional int64 user_value3 = 52; //用户字段3
|
||
}
|
||
|
||
//获取好友列表
|
||
message CMFriendList
|
||
{
|
||
}
|
||
//好友列表回复
|
||
message SMFriendList
|
||
{
|
||
optional int32 errcode = 1; //错误消息
|
||
optional string errmsg = 2; //错误消息
|
||
repeated MFUserInfo friend_list = 3; //好友列表
|
||
}
|
||
|
||
//好友申请
|
||
message CMFriendApply
|
||
{
|
||
optional string friend_id = 1; //好友id
|
||
optional string msg = 2; //消息
|
||
}
|
||
//好友申请回复
|
||
message SMFriendApply
|
||
{
|
||
optional int32 errcode = 1; //1:已经是好友
|
||
optional string errmsg = 2; //消息描述
|
||
}
|
||
|
||
//获取好友申请列表
|
||
message CMFriendApplyList
|
||
{
|
||
optional MFPaging paging = 1; //分页信息
|
||
}
|
||
//获取好友申请列表回复
|
||
message SMFriendApplyList
|
||
{
|
||
optional int32 errcode = 1; //
|
||
optional string errmsg = 2; //错误消息
|
||
optional MFPaging paging = 3; //分页信息回传
|
||
repeated MFFriendApply apply_list = 4; //申请加好友列表
|
||
}
|
||
|
||
//同意申请
|
||
message CMFriendAgree
|
||
{
|
||
optional MFFriendApply apply = 1; //申请信息
|
||
}
|
||
//同意申请回复
|
||
message SMFriendAgree
|
||
{
|
||
optional int32 errcode = 1; //错误码
|
||
optional string errmsg = 2; //错误消息
|
||
}
|
||
|
||
//忽略好友申请
|
||
message CMFriendIgnore
|
||
{
|
||
optional MFFriendApply apply = 1; //申请信息
|
||
}
|
||
//忽略好友申请回复
|
||
message SMFriendIgnore
|
||
{
|
||
optional int32 errcode = 1; //错误码
|
||
optional string errmsg = 2; //错误消息
|
||
}
|
||
|
||
//拒绝好友申请
|
||
message CMFriendRefuse
|
||
{
|
||
optional MFFriendApply apply = 1; //申请信息
|
||
}
|
||
//拒绝好友申请回复
|
||
message SMFriendRefuse
|
||
{
|
||
optional int32 errcode = 1; //错误码
|
||
optional string errmsg = 2; //错误消息
|
||
}
|
||
|
||
//删除好友
|
||
message CMFriendDelete
|
||
{
|
||
optional string friend_id = 1; //好友id
|
||
}
|
||
//删除好友回复
|
||
message SMFriendDelete
|
||
{
|
||
optional int32 errcode = 1; //错误码
|
||
optional string errmsg = 2; //错误消息
|
||
optional string friend_id = 3; //好友id
|
||
}
|
||
|
||
//获取黑名单列表
|
||
message CMFriendBlackList
|
||
{
|
||
}
|
||
//获取黑名单回复
|
||
message SMFriendBlackList
|
||
{
|
||
optional int32 errcode = 1; //
|
||
optional string errmsg = 2; //错误消息
|
||
}
|
||
|
||
//添加黑名单
|
||
message CMFriendAddBlack
|
||
{
|
||
}
|
||
//添加黑名单回复
|
||
message SMFriendAddBlack
|
||
{
|
||
optional int32 errcode = 1; //
|
||
optional string errmsg = 2; //错误消息
|
||
}
|
||
|
||
//删除黑名单
|
||
message CMFriendDeleteBlack
|
||
{
|
||
}
|
||
//删除黑名单回复
|
||
message SMFriendDeleteBlack
|
||
{
|
||
optional int32 errcode = 1; //
|
||
optional string errmsg = 2; //错误消息
|
||
}
|
||
|
||
//建群
|
||
message CMGroupCreate
|
||
{
|
||
optional string group_name = 1; //群名称
|
||
}
|
||
//建群返回
|
||
message SMGroupCreate
|
||
{
|
||
optional int32 errcode = 1; //1:群已存在 2: 你已经有群
|
||
optional string errmsg = 2; //错误消息
|
||
}
|
||
|
||
//加群
|
||
message CMGroupJoin
|
||
{
|
||
optional int64 group_id = 1; //群id
|
||
}
|
||
//加群返回
|
||
message SMGroupJoin
|
||
{
|
||
optional int32 errcode = 1; //1:群id不存在 2:群已满
|
||
optional string errmsg = 2; //错误消息
|
||
}
|
||
|
||
//同意加群
|
||
message CMGroupAgree
|
||
{
|
||
}
|
||
message SMGroupAgree
|
||
{
|
||
optional int32 errcode = 1;
|
||
optional string errmsg = 2;
|
||
}
|
||
|
||
//踢人
|
||
message CMGroupKick
|
||
{
|
||
optional string account_id = 1;
|
||
}
|
||
|
||
//踢人回复
|
||
message SMGroupKick
|
||
{
|
||
optional int32 errcode = 1; //1:群id错误
|
||
optional string errmsg = 2; //错误消息
|
||
}
|
||
|
||
//退群
|
||
message CMGroupQuit
|
||
{
|
||
}
|
||
message SMGroupQuit
|
||
{
|
||
optional int32 errcode = 1; //错误码
|
||
optional string errmsg = 2; //错误消息
|
||
}
|
||
|
||
//解散群
|
||
message CMGroupDismiss
|
||
{
|
||
}
|
||
message SMGroupDismiss
|
||
{
|
||
optional int32 errcode = 1; //错误码
|
||
optional string errmsg = 2; //错误信息
|
||
}
|
||
|
||
//群改名
|
||
message CMGroupRename
|
||
{
|
||
optional string new_group_name = 1; //新群名
|
||
}
|
||
message SMGroupRename
|
||
{
|
||
optional int32 errcode = 1; //错误码
|
||
optional string errmsg = 2; //错误信息
|
||
}
|
||
|
||
//发送聊天消息
|
||
message CMSendChatMsg
|
||
{
|
||
optional int32 chat_channel = 1; //聊天频道
|
||
optional string target = 2; //目标
|
||
optional string msg = 3; //消息内容
|
||
}
|
||
|
||
//发送自定义消息
|
||
message CMSendCustomMsg
|
||
{
|
||
repeated string target_list = 1; //目标列表
|
||
optional string msg = 2; //消息内容
|
||
optional int64 param1 = 3; //透传参数1
|
||
optional int64 param2 = 4; //透传参数2
|
||
optional int64 param3 = 5; //透传参数3
|
||
}
|
||
|
||
//更新临时自定义数据
|
||
message CMUpdateTempCustomData
|
||
{
|
||
/*
|
||
更新方式
|
||
0: 覆盖
|
||
1: 用新数据和服务器数据做或运算
|
||
2: 用新数据和服务器数据做与运算
|
||
|
||
!!!注意
|
||
MFUserRaltimeData走的是增量更新如果不需要处理的字段不传就行
|
||
服务器对未传的自动不做任何处理
|
||
*/
|
||
optional int32 update_type = 1; //更新方式
|
||
optional MFUserTempCustomData temp_custom_data = 2; //临时自定义数据
|
||
}
|
||
|
||
//用户上/下线通知
|
||
message SMUserStatusNotify
|
||
{
|
||
repeated string online_users = 1; //上线用户
|
||
repeated string offline_users = 2; //下线用户
|
||
}
|
||
|
||
//聊天消息通知
|
||
message SMChatMsgNotify
|
||
{
|
||
optional string sender = 1; //发送者
|
||
optional int32 chat_channel = 2; //聊天频道
|
||
optional string msg = 3; //消息内容
|
||
}
|
||
|
||
//发送自定义消息
|
||
message SMCustomMsgNotify
|
||
{
|
||
optional string sender = 1; //发送者
|
||
optional string msg = 2; //消息内容
|
||
optional int64 param1 = 3; //透传参数1
|
||
optional int64 param2 = 4; //透传参数2
|
||
optional int64 param3 = 5; //透传参数3
|
||
}
|
||
|
||
//更新用户信息
|
||
message SMUserInfoUpdate
|
||
{
|
||
repeated MFUserInfo user_infos = 1; //用户信息列表
|
||
}
|
||
|
||
//更新用户临时自定义信息
|
||
message SMUserTempCustomDataUpdate
|
||
{
|
||
optional string account_id = 1; //账号id
|
||
optional MFUserTempCustomData temp_custom_data = 2; //用户临时自定义数据
|
||
}
|