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
|
// SPDX-FileCopyrightText: 2020 Ethel Morgan
//
// SPDX-License-Identifier: MIT
package catbus
import (
"fmt"
"math/rand"
"os"
"path"
"sync"
"time"
mqtt "github.com/eclipse/paho.mqtt.golang"
)
type (
client struct {
mqtt mqtt.Client
subscribeEveryMessage bool
payloadByTopicMu sync.Mutex
payloadByTopic map[string]string
onconnectTimerByTopicMu sync.Mutex
onconnectTimerByTopic map[string]*time.Timer
onconnectDelay time.Duration
onconnectJitter time.Duration
// syncCallbacks makes callbacks synchronous.
// ONLY FOR TESTING.
syncCallbacks bool
}
ClientOptions struct {
DisconnectHandler func(Client, error)
ConnectHandler func(Client)
// SubscribeEveryMessage determines if the Subscribe callback will be called for all incoming messages.
// When SubscribeEveryMessage is false, the Subscribe callback will only trigger when the value changes.
SubscribeEveryMessage bool
// Publish previously seen or default values on connecting after OnconnectDelay ± [0,OnconnectJitter).
OnconnectDelay time.Duration
OnconnectJitter time.Duration
// DefaultPayloadByTopic are optional values to publish on connect if no prior values are seen.
// E.g. unless we've been told otherwise, assume a device is off.
DefaultPayloadByTopic map[string]string
}
)
const (
atMostOnce byte = iota
atLeastOnce
exactlyOnce
)
const (
DefaultOnconnectDelay = 1 * time.Minute
DefaultOnconnectJitter = 15 * time.Second
)
func NewClient(brokerURI string, options ClientOptions) Client {
client := &client{
subscribeEveryMessage: options.SubscribeEveryMessage,
payloadByTopic: map[string]string{},
onconnectTimerByTopic: map[string]*time.Timer{},
onconnectDelay: DefaultOnconnectDelay,
onconnectJitter: DefaultOnconnectJitter,
}
if options.OnconnectDelay != 0 {
client.onconnectDelay = options.OnconnectDelay
}
if options.OnconnectJitter != 0 {
client.onconnectJitter = options.OnconnectJitter
}
for topic, payload := range options.DefaultPayloadByTopic {
client.payloadByTopic[topic] = payload
}
mqttOpts := mqtt.NewClientOptions()
mqttOpts.AddBroker(brokerURI)
mqttOpts.SetAutoReconnect(true)
mqttOpts.SetClientID(defaultClientID())
mqttOpts.SetOnConnectHandler(func(_ mqtt.Client) {
client.stopAllTimers()
client.startAllTimers()
if options.ConnectHandler != nil {
go options.ConnectHandler(client)
}
})
mqttOpts.SetConnectionLostHandler(func(_ mqtt.Client, err error) {
client.stopAllTimers()
if options.DisconnectHandler != nil {
go options.DisconnectHandler(client, err)
}
})
client.mqtt = mqtt.NewClient(mqttOpts)
return client
}
// Connect connects to the Catbus MQTT broker and blocks forever.
func (c *client) Connect() error {
if err := c.mqtt.Connect().Error(); err != nil {
return err
}
select {}
}
// Subscribe subscribes to a Catbus MQTT topic.
func (c *client) Subscribe(topic string, f MessageHandler) error {
return c.mqtt.Subscribe(topic, atLeastOnce, func(_ mqtt.Client, raw mqtt.Message) {
msg := messageFromMQTTMessage(raw)
if c.subscribeEveryMessage || msg.Payload != c.payloadForTopic(topic) {
c.storePayload(msg.Topic, msg.Retention, msg.Payload)
if c.syncCallbacks {
f(c, msg)
} else {
go f(c, msg)
}
}
}).Error()
}
// Publish publishes to a Catbus MQTT topic.
func (c *client) Publish(topic string, retention Retention, payload string) error {
c.storePayload(topic, retention, payload)
return c.mqtt.Publish(topic, atLeastOnce, bool(retention), payload).Error()
}
func (c *client) jitteredOnconnectDelay() time.Duration {
jitter := time.Duration(rand.Intn(int(c.onconnectJitter)))
if rand.Intn(2) == 0 {
return c.onconnectDelay + jitter
}
return c.onconnectDelay - jitter
}
func (c *client) payloadForTopic(topic string) string {
c.payloadByTopicMu.Lock()
defer c.payloadByTopicMu.Unlock()
return c.payloadByTopic[topic]
}
func (c *client) storePayload(topic string, retention Retention, payload string) {
c.payloadByTopicMu.Lock()
defer c.payloadByTopicMu.Unlock()
if _, ok := c.payloadByTopic[topic]; !ok && retention == DontRetain {
// If we don't have a copy, and the sender doesn't want it retained, don't retain it.
return
}
c.stopTimer(topic)
if len(payload) == 0 {
delete(c.payloadByTopic, topic)
return
}
c.payloadByTopic[topic] = payload
}
func (c *client) stopTimer(topic string) {
c.onconnectTimerByTopicMu.Lock()
defer c.onconnectTimerByTopicMu.Unlock()
if timer, ok := c.onconnectTimerByTopic[topic]; ok {
_ = timer.Stop()
}
}
func (c *client) stopAllTimers() {
c.onconnectTimerByTopicMu.Lock()
defer c.onconnectTimerByTopicMu.Unlock()
for _, timer := range c.onconnectTimerByTopic {
_ = timer.Stop()
}
}
func (c *client) startAllTimers() {
c.payloadByTopicMu.Lock()
defer c.payloadByTopicMu.Unlock()
c.onconnectTimerByTopicMu.Lock()
defer c.onconnectTimerByTopicMu.Unlock()
for topic := range c.payloadByTopic {
c.onconnectTimerByTopic[topic] = time.AfterFunc(c.jitteredOnconnectDelay(), func() {
c.payloadByTopicMu.Lock()
payload, ok := c.payloadByTopic[topic]
c.payloadByTopicMu.Unlock()
if !ok {
return
}
_ = c.Publish(topic, Retain, payload)
})
}
}
func messageFromMQTTMessage(msg mqtt.Message) Message {
return Message{
Payload: string(msg.Payload()),
Retention: Retention(msg.Retained()),
Topic: msg.Topic(),
}
}
func defaultClientID() string {
binary := path.Base(os.Args[0])
hostname, _ := os.Hostname()
pid := os.Getpid()
return fmt.Sprintf("%s_%s_%d", binary, hostname, pid)
}
|
