forked from ruizeng/pando-cloud
-
Notifications
You must be signed in to change notification settings - Fork 0
/
message.go
696 lines (581 loc) · 14.8 KB
/
message.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
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
package mqtt
import (
"bytes"
"errors"
"io"
)
// OoS only support QoS 0
const (
QosAtMostOnce = TagQosLevel(iota)
QosAtLeastOnce
QosExactlyOnce
QosInvalid
)
// Max Payload size
const (
MaxPayloadSize = (1 << (4 * 7)) - 1
)
type TagQosLevel uint8
func (qos TagQosLevel) IsValid() bool {
return qos < QosInvalid && qos >= QosAtMostOnce
}
func (qos TagQosLevel) HasId() bool {
return qos == QosAtLeastOnce || qos == QosExactlyOnce
}
func (qos TagQosLevel) IsAtLeastOnce() bool {
return qos == QosAtLeastOnce
}
func (qos TagQosLevel) IsExactlyOnce() bool {
return qos == QosExactlyOnce
}
// Message Type
const (
MsgConnect = TagMessageType(iota + 1)
MsgConnAck
MsgPublish
MsgPubAck
MsgPubRec
MsgPubRel
MsgPubComp
MsgSubscribe
MsgSubAck
MsgUnsubscribe
MsgUnsubAck
MsgPingReq
MsgPingResp
MsgDisconnect
MsgInvalid
)
// retcode
const (
RetCodeAccepted = TagRetCode(iota)
RetCodeUnacceptableProtocolVersion
RetCodeIdentifierRejected
RetCodeServerUnavailable
RetCodeBadUsernameOrPassword
RetCodeNotAuthorized
RetCodeInvalid
)
type TagRetCode uint8
func (rc TagRetCode) IsValid() bool {
return rc >= RetCodeAccepted && rc < RetCodeInvalid
}
type TagMessageType uint8
func (msg TagMessageType) IsValid() bool {
return msg >= MsgConnect && msg < MsgInvalid
}
// message interface
type Message interface {
Encode(w io.Writer) error
Decode(r io.Reader, hdr Header, packetRemaining int32) error
}
// message fix header
type Header struct {
DupFlag bool
QosLevel TagQosLevel
Retain bool
}
func (hdr *Header) Encode(w io.Writer, msgType TagMessageType, remainingLength int32) error {
buf := new(bytes.Buffer)
err := hdr.EncodeInto(buf, msgType, remainingLength)
if err != nil {
return err
}
_, err = w.Write(buf.Bytes())
return err
}
func (hdr *Header) EncodeInto(buf *bytes.Buffer, msgType TagMessageType, remainingLength int32) error {
if !hdr.QosLevel.IsValid() {
return errors.New("Invalid Qos level")
}
if !msgType.IsValid() {
return errors.New("Invalid MsgType")
}
val := byte(msgType) << 4
val |= (boolToByte(hdr.DupFlag) << 3)
val |= byte(hdr.QosLevel) << 1
val |= boolToByte(hdr.Retain)
buf.WriteByte(val)
encodeLength(remainingLength, buf)
return nil
}
func (hdr *Header) Decode(r io.Reader) (msgType TagMessageType, remainingLength int32, err error) {
var buf [1]byte
if _, err := io.ReadFull(r, buf[:]); err != nil {
return 0, 0, err
}
byte1 := buf[0]
msgType = TagMessageType(byte1 & 0xf0 >> 4)
*hdr = Header{
DupFlag: byte1&0x08 > 0,
QosLevel: TagQosLevel(byte1 & 0x06 >> 1),
Retain: byte1&0x01 > 0,
}
remainingLength, err = decodeLength(r)
return msgType, remainingLength, err
}
func writeMessage(w io.Writer, msgType TagMessageType, hdr *Header, payloadBuf *bytes.Buffer, extraLength int32) error {
totalPayloadLength := int64(len(payloadBuf.Bytes())) + int64(extraLength)
if totalPayloadLength > MaxPayloadSize {
return errors.New("message too long")
}
buf := new(bytes.Buffer)
err := hdr.EncodeInto(buf, msgType, int32(totalPayloadLength))
if err != nil {
return err
}
buf.Write(payloadBuf.Bytes())
_, err = w.Write(buf.Bytes())
return err
}
// Connect represents an MQTT CONNECT message.
type Connect struct {
Header
ProtocolName string
ProtocolVersion uint8
WillRetain bool
WillFlag bool
CleanSession bool
WillQos TagQosLevel
KeepAliveTimer uint16
ClientId string
WillTopic, WillMessage string
UsernameFlag, PasswordFlag bool
Username, Password string
}
func (msg *Connect) Encode(w io.Writer) (err error) {
if msg.WillQos > QosInvalid {
return errors.New("invalid Qos")
}
buf := new(bytes.Buffer)
flags := boolToByte(msg.UsernameFlag) << 7
flags |= boolToByte(msg.PasswordFlag) << 6
flags |= boolToByte(msg.WillRetain) << 5
flags |= byte(msg.WillQos) << 3
flags |= boolToByte(msg.WillFlag) << 2
flags |= boolToByte(msg.CleanSession) << 1
setString(msg.ProtocolName, buf)
setUint8(msg.ProtocolVersion, buf)
buf.WriteByte(flags)
setUint16(msg.KeepAliveTimer, buf)
setString(msg.ClientId, buf)
if msg.WillFlag {
setString(msg.WillTopic, buf)
setString(msg.WillMessage, buf)
}
if msg.UsernameFlag {
setString(msg.Username, buf)
}
if msg.PasswordFlag {
setString(msg.Password, buf)
}
return writeMessage(w, MsgConnect, &msg.Header, buf, 0)
}
func (msg *Connect) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
protocolName, err := getString(r, &packetRemaining)
if err != nil {
return err
}
protocolVersion, err := getUint8(r, &packetRemaining)
if err != nil {
return err
}
flags, err := getUint8(r, &packetRemaining)
if err != nil {
return err
}
keepAliveTimer, err := getUint16(r, &packetRemaining)
if err != nil {
return err
}
clientId, err := getString(r, &packetRemaining)
if err != nil {
return err
}
*msg = Connect{
Header: hdr,
ProtocolName: protocolName,
ProtocolVersion: protocolVersion,
UsernameFlag: flags&0x80 > 0,
PasswordFlag: flags&0x40 > 0,
WillRetain: flags&0x20 > 0,
WillQos: TagQosLevel(flags & 0x18 >> 3),
WillFlag: flags&0x04 > 0,
CleanSession: flags&0x02 > 0,
KeepAliveTimer: keepAliveTimer,
ClientId: clientId,
}
if msg.WillFlag {
msg.WillTopic, err = getString(r, &packetRemaining)
if err != nil {
return err
}
msg.WillMessage, err = getString(r, &packetRemaining)
if err != nil {
return err
}
}
if msg.UsernameFlag {
msg.Username, err = getString(r, &packetRemaining)
if err != nil {
return err
}
}
if msg.PasswordFlag {
msg.Password, err = getString(r, &packetRemaining)
if err != nil {
return err
}
}
if packetRemaining != 0 {
return errors.New("message too long")
}
return nil
}
// ConnAck represents an MQTT CONNACK message.
type ConnAck struct {
Header
ReturnCode TagRetCode
}
func (msg *ConnAck) Encode(w io.Writer) (err error) {
buf := new(bytes.Buffer)
buf.WriteByte(byte(0)) // Reserved byte.
setUint8(uint8(msg.ReturnCode), buf)
return writeMessage(w, MsgConnAck, &msg.Header, buf, 0)
}
func (msg *ConnAck) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
msg.Header = hdr
_, err = getUint8(r, &packetRemaining) // Skip reserved byte.
if err != nil {
return err
}
code, err := getUint8(r, &packetRemaining)
if err != nil {
return err
}
msg.ReturnCode = TagRetCode(code)
if !msg.ReturnCode.IsValid() {
return errors.New("invliad retcode")
}
if packetRemaining != 0 {
return errors.New("message too long")
}
return nil
}
// Publish represents an MQTT PUBLISH message.
type Publish struct {
Header
TopicName string
MessageId uint16
Payload Payload
}
func (msg *Publish) Encode(w io.Writer) (err error) {
buf := new(bytes.Buffer)
setString(msg.TopicName, buf)
if msg.Header.QosLevel.HasId() {
setUint16(msg.MessageId, buf)
}
if err = msg.Payload.WritePayload(buf); err != nil {
return err
}
if err = writeMessage(w, MsgPublish, &msg.Header, buf, int32(0)); err != nil {
return err
}
return nil
}
func (msg *Publish) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
msg.Header = hdr
msg.TopicName, err = getString(r, &packetRemaining)
if err != nil {
return err
}
if msg.Header.QosLevel.HasId() {
msg.MessageId, err = getUint16(r, &packetRemaining)
if err != nil {
return err
}
}
payloadReader := &io.LimitedReader{r, int64(packetRemaining)}
msg.Payload = make(BytesPayload, int(packetRemaining))
return msg.Payload.ReadPayload(payloadReader, int(packetRemaining))
}
// PubAck represents an MQTT PUBACK message.
type PubAck struct {
Header
MessageId uint16
}
func (msg *PubAck) Encode(w io.Writer) error {
return encodeAckCommon(w, &msg.Header, msg.MessageId, MsgPubAck)
}
func (msg *PubAck) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
msg.Header = hdr
return decodeAckCommon(r, packetRemaining, &msg.MessageId)
}
// PubRec represents an MQTT PUBREC message.
type PubRec struct {
Header
MessageId uint16
}
func (msg *PubRec) Encode(w io.Writer) error {
return encodeAckCommon(w, &msg.Header, msg.MessageId, MsgPubRec)
}
func (msg *PubRec) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
msg.Header = hdr
return decodeAckCommon(r, packetRemaining, &msg.MessageId)
}
// PubRel represents an MQTT PUBREL message.
type PubRel struct {
Header
MessageId uint16
}
func (msg *PubRel) Encode(w io.Writer) error {
return encodeAckCommon(w, &msg.Header, msg.MessageId, MsgPubRel)
}
func (msg *PubRel) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
msg.Header = hdr
return decodeAckCommon(r, packetRemaining, &msg.MessageId)
}
// PubComp represents an MQTT PUBCOMP message.
type PubComp struct {
Header
MessageId uint16
}
func (msg *PubComp) Encode(w io.Writer) error {
return encodeAckCommon(w, &msg.Header, msg.MessageId, MsgPubComp)
}
func (msg *PubComp) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
msg.Header = hdr
return decodeAckCommon(r, packetRemaining, &msg.MessageId)
}
// Subscribe represents an MQTT SUBSCRIBE message.
type Subscribe struct {
Header
MessageId uint16
Topics []TopicQos
}
type TopicQos struct {
Topic string
Qos TagQosLevel
}
func (msg *Subscribe) Encode(w io.Writer) (err error) {
buf := new(bytes.Buffer)
if msg.Header.QosLevel.HasId() {
setUint16(msg.MessageId, buf)
}
for _, topicSub := range msg.Topics {
setString(topicSub.Topic, buf)
setUint8(uint8(topicSub.Qos), buf)
}
return writeMessage(w, MsgSubscribe, &msg.Header, buf, 0)
}
func (msg *Subscribe) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
msg.Header = hdr
if msg.Header.QosLevel.HasId() {
msg.MessageId, err = getUint16(r, &packetRemaining)
if err != nil {
return err
}
}
var topics []TopicQos
for packetRemaining > 0 {
topic, err := getString(r, &packetRemaining)
if err != nil {
return err
}
qos, err := getUint8(r, &packetRemaining)
if err != nil {
return err
}
topics = append(topics, TopicQos{
Topic: topic,
Qos: TagQosLevel(qos),
})
}
msg.Topics = topics
return nil
}
// SubAck represents an MQTT SUBACK message.
type SubAck struct {
Header
MessageId uint16
TopicsQos []TagQosLevel
}
func (msg *SubAck) Encode(w io.Writer) (err error) {
buf := new(bytes.Buffer)
setUint16(msg.MessageId, buf)
for i := 0; i < len(msg.TopicsQos); i += 1 {
setUint8(uint8(msg.TopicsQos[i]), buf)
}
return writeMessage(w, MsgSubAck, &msg.Header, buf, 0)
}
func (msg *SubAck) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
msg.Header = hdr
msg.MessageId, err = getUint16(r, &packetRemaining)
if err != nil {
return err
}
topicsQos := make([]TagQosLevel, 0)
for packetRemaining > 0 {
qos, err := getUint8(r, &packetRemaining)
if err != nil {
return err
}
grantedQos := TagQosLevel(qos & 0x03)
topicsQos = append(topicsQos, grantedQos)
}
msg.TopicsQos = topicsQos
return nil
}
// Unsubscribe represents an MQTT UNSUBSCRIBE message.
type Unsubscribe struct {
Header
MessageId uint16
Topics []string
}
func (msg *Unsubscribe) Encode(w io.Writer) (err error) {
buf := new(bytes.Buffer)
if msg.Header.QosLevel.HasId() {
setUint16(msg.MessageId, buf)
}
for _, topic := range msg.Topics {
setString(topic, buf)
}
return writeMessage(w, MsgUnsubscribe, &msg.Header, buf, 0)
}
func (msg *Unsubscribe) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
msg.Header = hdr
if msg.Header.QosLevel.HasId() {
msg.MessageId, err = getUint16(r, &packetRemaining)
if err != nil {
return err
}
}
topics := make([]string, 0)
for packetRemaining > 0 {
topic, err := getString(r, &packetRemaining)
if err != nil {
return err
}
topics = append(topics, topic)
}
msg.Topics = topics
return nil
}
// UnsubAck represents an MQTT UNSUBACK message.
type UnsubAck struct {
Header
MessageId uint16
}
func (msg *UnsubAck) Encode(w io.Writer) error {
return encodeAckCommon(w, &msg.Header, msg.MessageId, MsgUnsubAck)
}
func (msg *UnsubAck) Decode(r io.Reader, hdr Header, packetRemaining int32) (err error) {
msg.Header = hdr
return decodeAckCommon(r, packetRemaining, &msg.MessageId)
}
// PingReq represents an MQTT PINGREQ message.
type PingReq struct {
Header
}
func (msg *PingReq) Encode(w io.Writer) error {
return msg.Header.Encode(w, MsgPingReq, 0)
}
func (msg *PingReq) Decode(r io.Reader, hdr Header, packetRemaining int32) error {
if packetRemaining != 0 {
return errors.New("msg too long")
}
return nil
}
// PingResp represents an MQTT PINGRESP message.
type PingResp struct {
Header
}
func (msg *PingResp) Encode(w io.Writer) error {
return msg.Header.Encode(w, MsgPingResp, 0)
}
func (msg *PingResp) Decode(r io.Reader, hdr Header, packetRemaining int32) error {
if packetRemaining != 0 {
return errors.New("msg too long")
}
return nil
}
// Disconnect represents an MQTT DISCONNECT message.
type Disconnect struct {
Header
}
func (msg *Disconnect) Encode(w io.Writer) error {
return msg.Header.Encode(w, MsgDisconnect, 0)
}
func (msg *Disconnect) Decode(r io.Reader, hdr Header, packetRemaining int32) error {
if packetRemaining != 0 {
return errors.New("msg too long")
}
return nil
}
func encodeAckCommon(w io.Writer, hdr *Header, messageId uint16, msgType TagMessageType) error {
buf := new(bytes.Buffer)
setUint16(messageId, buf)
return writeMessage(w, msgType, hdr, buf, 0)
}
func decodeAckCommon(r io.Reader, packetRemaining int32, messageId *uint16) (err error) {
*messageId, err = getUint16(r, &packetRemaining)
if err != nil {
return err
}
if packetRemaining != 0 {
return errors.New("msg too long")
}
return nil
}
// DecodeOneMessage decodes one message from r. config provides specifics on
// how to decode messages, nil indicates that the DefaultDecoderConfig should
// be used.
func DecodeOneMessage(r io.Reader) (msg Message, err error) {
var hdr Header
var msgType TagMessageType
var packetRemaining int32
msgType, packetRemaining, err = hdr.Decode(r)
if err != nil {
return nil, err
}
msg, err = NewMessage(msgType)
if err != nil {
return nil, err
}
return msg, msg.Decode(r, hdr, packetRemaining)
}
func NewMessage(msgType TagMessageType) (msg Message, err error) {
switch msgType {
case MsgConnect:
msg = new(Connect)
case MsgConnAck:
msg = new(ConnAck)
case MsgPublish:
msg = new(Publish)
case MsgPubAck:
msg = new(PubAck)
case MsgPubRec:
msg = new(PubRec)
case MsgPubRel:
msg = new(PubRel)
case MsgPubComp:
msg = new(PubComp)
case MsgSubscribe:
msg = new(Subscribe)
case MsgUnsubAck:
msg = new(UnsubAck)
case MsgSubAck:
msg = new(SubAck)
case MsgUnsubscribe:
msg = new(Unsubscribe)
case MsgPingReq:
msg = new(PingReq)
case MsgPingResp:
msg = new(PingResp)
case MsgDisconnect:
msg = new(Disconnect)
default:
return nil, errors.New("msgType error")
}
return msg, nil
}