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
|
package centrifuge
import "context"
// Credentials allows to authenticate connection when set into context.
type Credentials struct {
// UserID tells library an ID of current user. Leave this empty string
// if you need access from anonymous user.
UserID string
// ExpireAt allows to set time in future when connection must be validated.
// In this case Client.OnRefresh callback must be set by application. Zero
// value means no expiration.
ExpireAt int64
// Info contains additional information about connection. This data will be
// included untouched into Join/Leave messages, into Presence information,
// also info can become a part of published message as part of ClientInfo.
// In some cases having additional info can be an undesired overhead – but
// you are simply free to not use this field at all.
Info []byte
}
// credentialsContextKeyType is special type to safely use context for setting
// and getting Credentials.
type credentialsContextKeyType int
// credentialsContextKey allows Go code to set Credentials into context.
var credentialsContextKey credentialsContextKeyType
// SetCredentials allows to set connection Credentials to Context. Credentials set
// to Context in authentication middleware will be used by Centrifuge library to
// authenticate user.
func SetCredentials(ctx context.Context, cred *Credentials) context.Context {
ctx = context.WithValue(ctx, credentialsContextKey, cred)
return ctx
}
// GetCredentials allows to extract Credentials from Context (if set previously).
func GetCredentials(ctx context.Context) (*Credentials, bool) {
if val := ctx.Value(credentialsContextKey); val != nil {
cred, ok := val.(*Credentials)
return cred, ok
}
return nil, false
}
|
