forked from liangdas/mqant
/
define.go
157 lines (148 loc) · 5.45 KB
/
define.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
// Copyright 2014 mqant Author. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package gate
import (
"github.com/liangdas/mqant/network"
opentracing "github.com/opentracing/opentracing-go"
)
/**
net代理服务 处理器
*/
type GateHandler interface {
Bind(Sessionid string, Userid string) (result Session, err string) //Bind the session with the the Userid.
UnBind(Sessionid string) (result Session, err string) //UnBind the session with the the Userid.
Set(Sessionid string, key string, value string) (result Session, err string) //Set values (one or many) for the session.
Remove(Sessionid string, key string) (result interface{}, err string) //Remove value from the session.
Push(Sessionid string, Settings map[string]string) (result Session, err string) //推送信息给Session
Send(Sessionid string, topic string, body []byte) (result interface{}, err string) //Send message
//查询某一个userId是否连接中,这里只是查询这一个网关里面是否有userId客户端连接,如果有多个网关就需要遍历了
IsConnect(Sessionid string, Userid string) (result bool, err string)
Close(Sessionid string) (result interface{}, err string) //主动关闭连接
Update(Sessionid string) (result Session, err string) //更新整个Session 通常是其他模块拉取最新数据
OnDestroy() //退出事件,主动关闭所有的连接
}
type Session interface {
GetIP() string
GetNetwork() string
GetUserid() string
GetSessionid() string
GetServerid() string
GetSettings() map[string]string
SetIP(ip string)
SetNetwork(network string)
SetUserid(userid string)
SetSessionid(sessionid string)
SetServerid(serverid string)
SetSettings(settings map[string]string)
Serializable() ([]byte, error)
Update() (err string)
Bind(Userid string) (err string)
UnBind() (err string)
Push() (err string)
Set(key string, value string) (err string)
SetPush(key string, value string) (err string) //设置值以后立即推送到gate网关
Get(key string) (result string)
Remove(key string) (err string)
Send(topic string, body []byte) (err string)
SendNR(topic string, body []byte) (err string)
//查询某一个userId是否连接中,这里只是查询这一个网关里面是否有userId客户端连接,如果有多个网关就需要遍历了
IsConnect(Userid string) (result bool, err string)
//是否是访客(未登录) ,默认判断规则为 userId==""代表访客
IsGuest() bool
//设置自动的访客判断函数,记得一定要在全局的时候设置这个值,以免部分模块因为未设置这个判断函数造成错误的判断
JudgeGuest(judgeGuest func(session Session) bool)
Close() (err string)
Clone() Session
/**
通过Carrier数据构造本次rpc调用的tracing Span,如果没有就创建一个新的
*/
CreateRootSpan(operationName string) opentracing.Span
/**
通过Carrier数据构造本次rpc调用的tracing Span,如果没有就返回nil
*/
LoadSpan(operationName string) opentracing.Span
/**
获取本次rpc调用的tracing Span
*/
Span() opentracing.Span
/**
从Session的 Span继承一个新的Span
*/
ExtractSpan(operationName string) opentracing.Span
/**
获取Tracing的Carrier 可能为nil
*/
TracCarrier() map[string]string
TracId() string
}
/**
Session信息持久化
*/
type StorageHandler interface {
/**
存储用户的Session信息
Session Bind Userid以后每次设置 settings都会调用一次Storage
*/
Storage(Userid string, session Session) (err error)
/**
强制删除Session信息
*/
Delete(Userid string) (err error)
/**
获取用户Session信息
Bind Userid时会调用Query获取最新信息
*/
Query(Userid string) (data []byte, err error)
/**
用户心跳,一般用户在线时1s发送一次
可以用来延长Session信息过期时间
*/
Heartbeat(Userid string)
}
type TracingHandler interface {
/**
是否需要对本次客户端请求进行跟踪
*/
OnRequestTracing(session Session, topic string, msg []byte) bool
}
type AgentLearner interface {
Connect(a Agent) //当连接建立 并且MQTT协议握手成功
DisConnect(a Agent) //当连接关闭 或者客户端主动发送MQTT DisConnect命令
}
type SessionLearner interface {
Connect(a Session) //当连接建立 并且MQTT协议握手成功
DisConnect(a Session) //当连接关闭 或者客户端主动发送MQTT DisConnect命令
}
type Agent interface {
OnInit(gate Gate, conn network.Conn) error
WriteMsg(topic string, body []byte) error
Close()
Run() (err error)
OnClose() error
Destroy()
RevNum() int64
SendNum() int64
IsClosed() bool
GetSession() Session
}
type Gate interface {
GetMinStorageHeartbeat() int64
GetGateHandler() GateHandler
GetAgentLearner() AgentLearner
GetSessionLearner() SessionLearner
GetStorageHandler() StorageHandler
GetTracingHandler() TracingHandler
NewSession(data []byte) (Session, error)
NewSessionByMap(data map[string]interface{}) (Session, error)
}