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 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
|
package centrifuge
import (
"context"
)
// ConnectEvent contains fields related to connecting event (when server
// received Connect protocol command from client).
type ConnectEvent struct {
// ClientID that was generated by library for client connection.
ClientID string
// Token received from client as part of Connect Command.
Token string
// Data received from client as part of Connect Command.
Data []byte
// Name can contain client name if provided on connect.
Name string
// Version can contain client version if provided on connect.
Version string
// Transport contains information about transport used by client.
Transport TransportInfo
}
// ConnectReply contains reaction to ConnectEvent.
type ConnectReply struct {
// Context allows to return modified context.
Context context.Context
// Credentials should be set if app wants to authenticate connection.
// This field is optional since auth Credentials could be set through
// HTTP middleware.
Credentials *Credentials
// Data allows to set custom data in connect reply.
Data []byte
// Subscriptions map contains channels to subscribe connection to on server-side.
Subscriptions map[string]SubscribeOptions
// ClientSideRefresh tells library to use client-side refresh logic:
// i.e. send refresh commands with new connection token. If not set
// then server-side refresh mechanism will be used.
ClientSideRefresh bool
}
// ConnectingHandler called when new client authenticates on server.
type ConnectingHandler func(context.Context, ConnectEvent) (ConnectReply, error)
// ConnectHandler called when client connected to server and ready to communicate.
type ConnectHandler func(*Client)
// RefreshEvent contains fields related to refresh event.
type RefreshEvent struct {
// ClientSideRefresh is true for refresh initiated by client-side refresh workflow.
ClientSideRefresh bool
// Token will only be set in case of using client-side refresh mechanism.
Token string
}
// RefreshReply contains fields determining the reaction on refresh event.
type RefreshReply struct {
// Expired tells Centrifuge that connection expired. In this case connection will be
// closed with DisconnectExpired.
Expired bool
// ExpireAt defines time in future when connection should expire,
// zero value means no expiration.
ExpireAt int64
// Info allows to modify connection information,
// zero value means no modification of current connection Info.
Info []byte
}
// RefreshCallback should be called as soon as handler decides what to do
// with connection refresh event.
type RefreshCallback func(RefreshReply, error)
// RefreshHandler called when it's time to validate client connection and
// update it's expiration time if it's still actual.
//
// Centrifuge library supports two ways of refreshing connection: client-side
// and server-side.
//
// The default mechanism is server-side, this means that as soon refresh handler
// set and connection expiration time happens (by timer) – refresh handler will
// be called.
//
// If ClientSideRefresh in ConnectReply inside ConnectingHandler set to true then
// library uses client-side refresh mechanism. In this case library relies on
// Refresh commands sent from client periodically to refresh connection. Refresh
// command contains updated connection token.
type RefreshHandler func(RefreshEvent, RefreshCallback)
// AliveHandler called periodically while connection alive. This is a helper
// to do periodic things which can tolerate some approximation in time. This
// callback will run every ClientPresenceUpdateInterval and can save you a timer.
type AliveHandler func()
// DisconnectEvent contains fields related to disconnect event.
type DisconnectEvent struct {
// Disconnect can optionally contain a custom disconnect object that
// was sent from server to client with closing handshake. If this field
// exists then client connection was closed from server. If this field
// is nil then this means that client disconnected normally and connection
// closing was initiated by client side.
Disconnect *Disconnect
}
// DisconnectHandler called when client disconnects from server. The important
// thing to remember is that you should not rely entirely on this handler to
// clean up non-expiring resources (in your database for example). Why? Because
// in case of any non-graceful node shutdown (kill -9, process crash, machine lost)
// disconnect handler will never be called (obviously) so you can have stale data.
type DisconnectHandler func(DisconnectEvent)
// SubscribeEvent contains fields related to subscribe event.
type SubscribeEvent struct {
// Channel client wants to subscribe to.
Channel string
// Token will only be set for token channels. This is a task of application
// to check that subscription to a channel has valid token.
Token string
}
// SubscribeCallback should be called as soon as handler decides what to do
// with connection subscribe event.
type SubscribeCallback func(SubscribeReply, error)
// SubscribeReply contains fields determining the reaction on subscribe event.
type SubscribeReply struct {
// Options to control subscription.
Options SubscribeOptions
// ClientSideRefresh tells library to use client-side refresh logic: i.e. send
// SubRefresh commands with new Subscription Token. If not set then server-side
// SubRefresh handler will be used.
ClientSideRefresh bool
}
// SubscribeHandler called when client wants to subscribe on channel.
type SubscribeHandler func(SubscribeEvent, SubscribeCallback)
// UnsubscribeEvent contains fields related to unsubscribe event.
type UnsubscribeEvent struct {
// Channel client unsubscribed from.
Channel string
}
// UnsubscribeHandler called when client unsubscribed from channel.
type UnsubscribeHandler func(UnsubscribeEvent)
// PublishEvent contains fields related to publish event. Note that this event
// called before actual publish to Broker so handler has an option to reject this
// publication returning an error.
type PublishEvent struct {
// Channel client wants to publish data to.
Channel string
// Data client wants to publish.
Data []byte
// ClientInfo about client connection.
ClientInfo *ClientInfo
}
// PublishReply contains fields determining the result on publish.
type PublishReply struct {
// Options to control publication.
Options PublishOptions
// Result if set will tell Centrifuge that message already published to
// channel by handler code. In this case Centrifuge won't try to publish
// into channel again after handler returned PublishReply. This can be
// useful if you need to know new Publication offset in your code or you
// want to make sure message successfully published to Broker on server
// side (otherwise only client will get an error).
Result *PublishResult
}
// PublishCallback should be called with PublishReply or error.
type PublishCallback func(PublishReply, error)
// PublishHandler called when client publishes into channel.
type PublishHandler func(PublishEvent, PublishCallback)
// SubRefreshEvent contains fields related to subscription refresh event.
type SubRefreshEvent struct {
// ClientSideRefresh is true for refresh initiated by client-side subscription
// refresh workflow.
ClientSideRefresh bool
// Channel to which SubRefreshEvent belongs to.
Channel string
// Token will only be set in case of using client-side subscription refresh mechanism.
Token string
}
// SubRefreshReply contains fields determining the reaction on
// subscription refresh event.
type SubRefreshReply struct {
// Expired tells Centrifuge that subscription expired. In this case connection will be
// closed with DisconnectExpired.
Expired bool
// ExpireAt is a new Unix time of expiration. Zero value means no expiration.
ExpireAt int64
// Info is a new channel-scope info. Zero value means do not change previous one.
Info []byte
}
// SubRefreshCallback should be called as soon as handler decides what to do
// with connection SubRefreshEvent.
type SubRefreshCallback func(SubRefreshReply, error)
// SubRefreshHandler called when it's time to validate client subscription to channel and
// update it's state if needed.
//
// If ClientSideRefresh in SubscribeReply inside SubscribeHandler set to true then
// library uses client-side subscription refresh mechanism. In this case library relies on
// SubRefresh commands sent from client periodically to refresh subscription. SubRefresh
// command contains updated subscription token.
type SubRefreshHandler func(SubRefreshEvent, SubRefreshCallback)
// RPCEvent contains fields related to rpc request.
type RPCEvent struct {
// Method is an optional string that contains RPC method name client wants to call.
// This is an optional field, by default clients send RPC without any method set.
Method string
// Data contains RPC untouched payload.
Data []byte
}
// RPCReply contains fields determining the reaction on rpc request.
type RPCReply struct {
// Data to return in RPC reply to client.
Data []byte
}
// RPCCallback should be called as soon as handler decides what to do
// with connection RPCEvent.
type RPCCallback func(RPCReply, error)
// RPCHandler must handle incoming command from client.
type RPCHandler func(RPCEvent, RPCCallback)
// MessageEvent contains fields related to message request.
type MessageEvent struct {
// Data contains message untouched payload.
Data []byte
}
// MessageHandler must handle incoming async message from client.
type MessageHandler func(MessageEvent)
// PresenceEvent has channel operation called for.
type PresenceEvent struct {
Channel string
}
// PresenceReply contains fields determining the reaction on presence request.
type PresenceReply struct {
Result *PresenceResult
}
// PresenceCallback should be called with PresenceReply or error.
type PresenceCallback func(PresenceReply, error)
// PresenceHandler called when presence request received from client.
type PresenceHandler func(PresenceEvent, PresenceCallback)
// PresenceStatsEvent has channel operation called for.
type PresenceStatsEvent struct {
Channel string
}
// PresenceStatsReply contains fields determining the reaction on presence request.
type PresenceStatsReply struct {
Result *PresenceStatsResult
}
// PresenceStatsCallback should be called with PresenceStatsReply or error.
type PresenceStatsCallback func(PresenceStatsReply, error)
// PresenceStatsHandler must handle incoming command from client.
type PresenceStatsHandler func(PresenceStatsEvent, PresenceStatsCallback)
// HistoryEvent has channel operation called for.
type HistoryEvent struct {
Channel string
Filter HistoryFilter
}
// HistoryReply contains fields determining the reaction on history request.
type HistoryReply struct {
Result *HistoryResult
}
// HistoryCallback should be called with HistoryReply or error.
type HistoryCallback func(HistoryReply, error)
// HistoryHandler must handle incoming command from client.
type HistoryHandler func(HistoryEvent, HistoryCallback)
// SurveyEvent with Op and Data of survey.
type SurveyEvent struct {
Op string
Data []byte
}
// SurveyReply contains survey reply fields.
type SurveyReply struct {
Code uint32
Data []byte
}
// SurveyCallback should be called with SurveyReply as soon as survey completed.
type SurveyCallback func(SurveyReply)
// SurveyHandler allows to set survey handler function.
type SurveyHandler func(SurveyEvent, SurveyCallback)
|