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
|
package centrifuge
import "time"
// PublishOption is a type to represent various Publish options.
type PublishOption func(*PublishOptions)
// WithHistory tells Broker to save message to history stream with provided size and ttl.
func WithHistory(size int, ttl time.Duration) PublishOption {
return func(opts *PublishOptions) {
opts.HistorySize = size
opts.HistoryTTL = ttl
}
}
// WithClientInfo adds ClientInfo to Publication.
func WithClientInfo(info *ClientInfo) PublishOption {
return func(opts *PublishOptions) {
opts.ClientInfo = info
}
}
// SubscribeOptions define per-subscription options.
type SubscribeOptions struct {
// ExpireAt defines time in future when subscription should expire,
// zero value means no expiration.
ExpireAt int64
// ChannelInfo defines custom channel information, zero value means no channel information.
ChannelInfo []byte
// Presence turns on participating in channel presence.
Presence bool
// JoinLeave enables sending Join and Leave messages for this client in channel.
JoinLeave bool
// When position is on client will additionally sync its position inside
// a stream to prevent message loss. Make sure you are enabling Position in channels
// that maintain Publication history stream. When Position is on Centrifuge will
// include StreamPosition information to subscribe response - for a client to be able
// to manually track its position inside a stream.
Position bool
// Recover turns on recovery option for a channel. In this case client will try to
// recover missed messages automatically upon resubscribe to a channel after reconnect
// to a server. This option also enables client position tracking inside a stream
// (like Position option) to prevent occasional message loss. Make sure you are using
// Recover in channels that maintain Publication history stream.
Recover bool
}
// UnsubscribeOptions define some fields to alter behaviour of Unsubscribe operation.
type UnsubscribeOptions struct {
// Resubscribe allows to set resubscribe protocol flag.
Resubscribe bool
}
// UnsubscribeOption is a type to represent various Unsubscribe options.
type UnsubscribeOption func(*UnsubscribeOptions)
// WithResubscribe allows to set Resubscribe flag to true.
func WithResubscribe(resubscribe bool) UnsubscribeOption {
return func(opts *UnsubscribeOptions) {
opts.Resubscribe = resubscribe
}
}
// DisconnectOptions define some fields to alter behaviour of Disconnect operation.
type DisconnectOptions struct {
// Disconnect represents custom disconnect to use.
// By default DisconnectForceNoReconnect will be used.
Disconnect *Disconnect
// ClientWhitelist contains client IDs to keep.
ClientWhitelist []string
}
// DisconnectOption is a type to represent various Disconnect options.
type DisconnectOption func(options *DisconnectOptions)
// WithDisconnect allows to set custom Disconnect.
func WithDisconnect(disconnect *Disconnect) DisconnectOption {
return func(opts *DisconnectOptions) {
opts.Disconnect = disconnect
}
}
// WithClientWhitelist allows to set ClientWhitelist.
func WithClientWhitelist(whitelist []string) DisconnectOption {
return func(opts *DisconnectOptions) {
opts.ClientWhitelist = whitelist
}
}
// HistoryOptions define some fields to alter History method behaviour.
type HistoryOptions struct {
// Since used to extract publications from stream since provided StreamPosition.
Since *StreamPosition
// Limit number of publications to return.
// -1 means no limit - i.e. return all publications currently in stream.
// 0 means that caller only interested in current stream top position so
// Broker should not return any publications in result.
// Positive integer does what it should.
Limit int
}
// HistoryOption is a type to represent various History options.
type HistoryOption func(options *HistoryOptions)
// NoLimit defines that limit should not be applied.
const NoLimit = -1
// WithLimit allows to set limit.
func WithLimit(limit int) HistoryOption {
return func(opts *HistoryOptions) {
opts.Limit = limit
}
}
// Since allows to set Since option.
func Since(sp *StreamPosition) HistoryOption {
return func(opts *HistoryOptions) {
opts.Since = sp
}
}
|
