mqttcodec

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 7, 2020 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	MQTT            = "MQTT"
	MQTT_3_1_1 byte = 4
	MQTT_5     byte = 5
)
View Source 
const (
	CONNECT     byte = 1
	CONNACK     byte = 2
	PUBLISH     byte = 3
	PUBACK      byte = 4
	PUBREC      byte = 5
	PUBREL      byte = 6
	PUBCOMP     byte = 7
	SUBSCRIBE   byte = 8
	SUBACK      byte = 9
	UNSUBSCRIBE byte = 10
	UNSUBACK    byte = 11
	PINGREQ     byte = 12
	PINGRESP    byte = 13
	DISCONNECT  byte = 14
	AUTH        byte = 15 // mqtt-v5.0
)
View Source 
const (
	AT_MOST_ONCE  = 0
	AT_LEAST_ONCE = 1
	EXACTLY_ONCE  = 2
	FAILURE       = 0x80
)
View Source 
const (
	Accepted                           byte = 0
	RefusedUnacceptableProtocolVersion byte = 1
	RefusedIdentifierRejected          byte = 2
	RefusedServerUnavailable           byte = 3
	RefusedBadUserNameOrPassword       byte = 4
	RefusedNotAuthorized               byte = 5
)

Variables

View Source 
var MqttMessageTypeNames = map[byte]string{
	CONNECT:     "CONNECT",
	CONNACK:     "CONNACK",
	PUBLISH:     "PUBLISH",
	PUBACK:      "PUBACK",
	PUBREC:      "PUBREC",
	PUBREL:      "PUBREL",
	PUBCOMP:     "PUBCOMP",
	SUBSCRIBE:   "SUBSCRIBE",
	SUBACK:      "SUBACK",
	UNSUBSCRIBE: "UNSUBSCRIBE",
	UNSUBACK:    "UNSUBACK",
	PINGREQ:     "PINGREQ",
	PINGRESP:    "PINGRESP",
	DISCONNECT:  "DISCONNECT",
	AUTH:        "AUTH",
}
View Source 
var MqttQoSNames = map[byte]string{
	AT_MOST_ONCE:  "AT_MOST_ONCE",
	AT_LEAST_ONCE: "AT_LEAST_ONCE",
	EXACTLY_ONCE:  "EXACTLY_ONCE",
	FAILURE:       "FAILURE",
}

Functions

func NewConnAckError 

func NewConnAckError(returnCode byte, text string) error

Types

type ConnackPacket 

type ConnackPacket struct {
	FixedHeader
	SessionPresent bool
	ReturnCode     byte
}

func (*ConnackPacket) Name 

func (p *ConnackPacket) Name() string

func (*ConnackPacket) String 

func (p *ConnackPacket) String() string

func (*ConnackPacket) Type 

func (p *ConnackPacket) Type() byte

func (*ConnackPacket) Unpack 

func (p *ConnackPacket) Unpack(b io.Reader) error

func (*ConnackPacket) Write 

func (p *ConnackPacket) Write(w io.Writer) (err error)

type ConnectAckError 

type ConnectAckError struct {
	// contains filtered or unexported fields
}

func (*ConnectAckError) Error 

func (e *ConnectAckError) Error() string

func (*ConnectAckError) ReturnCode 

func (e *ConnectAckError) ReturnCode() byte

type ConnectPacket 

type ConnectPacket struct {
	FixedHeader

	ProtocolName     string
	ProtocolLevel    byte
	HasUsername      bool
	HasPassword      bool
	WillRetain       bool
	WillQos          byte
	WillFlag         bool
	CleanSession     bool
	ReservedBit      bool
	KeepAliveSeconds uint16

	ClientIdentifier string
	WillTopic        string
	WillMessage      []byte
	Username         string
	Password         []byte
}

func (*ConnectPacket) Name 

func (p *ConnectPacket) Name() string

func (*ConnectPacket) String 

func (p *ConnectPacket) String() string

func (*ConnectPacket) Type 

func (p *ConnectPacket) Type() byte

func (*ConnectPacket) Unpack 

func (p *ConnectPacket) Unpack(r io.Reader) (err error)

func (*ConnectPacket) Write 

func (p *ConnectPacket) Write(w io.Writer) (err error)

type ControlPacket 

type ControlPacket interface {
	Write(io.Writer) error
	Unpack(io.Reader) error
	String() string
	Type() byte
	Name() string
}

func NewControlPacket 

func NewControlPacket(packetType byte) ControlPacket

func NewControlPacketWithHeader 

func NewControlPacketWithHeader(fh FixedHeader) (ControlPacket, error)

func ReadPacket 

func ReadPacket(r io.Reader) (ControlPacket, error)

type DisconnectPacket 

type DisconnectPacket struct {
	FixedHeader
}

func (*DisconnectPacket) Name 

func (p *DisconnectPacket) Name() string

func (*DisconnectPacket) String 

func (p *DisconnectPacket) String() string

func (*DisconnectPacket) Type 

func (p *DisconnectPacket) Type() byte

func (*DisconnectPacket) Unpack 

func (p *DisconnectPacket) Unpack(_ io.Reader) error

func (*DisconnectPacket) Write 

func (p *DisconnectPacket) Write(w io.Writer) (err error)

type FixedHeader 

type FixedHeader struct {
	MessageType     byte
	Dup             bool
	Qos             byte
	Retain          bool
	RemainingLength int
}

func (*FixedHeader) MessageName 

func (fh *FixedHeader) MessageName() string

func (FixedHeader) String 

func (fh FixedHeader) String() string

type PingreqPacket 

type PingreqPacket struct {
	FixedHeader
}

func (*PingreqPacket) Name 

func (p *PingreqPacket) Name() string

func (*PingreqPacket) String 

func (p *PingreqPacket) String() string

func (*PingreqPacket) Type 

func (p *PingreqPacket) Type() byte

func (*PingreqPacket) Unpack 

func (p *PingreqPacket) Unpack(_ io.Reader) error

func (*PingreqPacket) Write 

func (p *PingreqPacket) Write(w io.Writer) (err error)

type PingrespPacket 

type PingrespPacket struct {
	FixedHeader
}

func (*PingrespPacket) Name 

func (p *PingrespPacket) Name() string

func (*PingrespPacket) String 

func (p *PingrespPacket) String() string

func (*PingrespPacket) Type 

func (p *PingrespPacket) Type() byte

func (*PingrespPacket) Unpack 

func (p *PingrespPacket) Unpack(_ io.Reader) error

func (*PingrespPacket) Write 

func (p *PingrespPacket) Write(w io.Writer) (err error)

type PubackPacket 

type PubackPacket struct {
	FixedHeader
	MessageID uint16
}

func (*PubackPacket) Name 

func (p *PubackPacket) Name() string

func (*PubackPacket) String 

func (p *PubackPacket) String() string

func (*PubackPacket) Type 

func (p *PubackPacket) Type() byte

func (*PubackPacket) Unpack 

func (p *PubackPacket) Unpack(b io.Reader) (err error)

func (*PubackPacket) Write 

func (p *PubackPacket) Write(w io.Writer) (err error)

type PubcompPacket 

type PubcompPacket struct {
	FixedHeader
	MessageID uint16
}

func (*PubcompPacket) Name 

func (p *PubcompPacket) Name() string

func (*PubcompPacket) String 

func (p *PubcompPacket) String() string

func (*PubcompPacket) Type 

func (p *PubcompPacket) Type() byte

func (*PubcompPacket) Unpack 

func (p *PubcompPacket) Unpack(b io.Reader) (err error)

func (*PubcompPacket) Write 

func (p *PubcompPacket) Write(w io.Writer) (err error)

type PublishPacket 

type PublishPacket struct {
	FixedHeader
	TopicName string
	MessageID uint16
	Message   []byte
}

func (*PublishPacket) Name 

func (c *PublishPacket) Name() string

func (*PublishPacket) String 

func (p *PublishPacket) String() string

func (*PublishPacket) Type 

func (p *PublishPacket) Type() byte

func (*PublishPacket) Unpack 

func (p *PublishPacket) Unpack(b io.Reader) (err error)

func (*PublishPacket) Write 

func (p *PublishPacket) Write(w io.Writer) (err error)

type PubrecPacket 

type PubrecPacket struct {
	FixedHeader
	MessageID uint16
}

func (*PubrecPacket) Name 

func (p *PubrecPacket) Name() string

func (*PubrecPacket) String 

func (p *PubrecPacket) String() string

func (*PubrecPacket) Type 

func (p *PubrecPacket) Type() byte

func (*PubrecPacket) Unpack 

func (p *PubrecPacket) Unpack(b io.Reader) (err error)

func (*PubrecPacket) Write 

func (p *PubrecPacket) Write(w io.Writer) (err error)

type PubrelPacket 

type PubrelPacket struct {
	FixedHeader
	MessageID uint16
}

func (*PubrelPacket) Name 

func (p *PubrelPacket) Name() string

func (*PubrelPacket) String 

func (p *PubrelPacket) String() string

func (*PubrelPacket) Type 

func (p *PubrelPacket) Type() byte

func (*PubrelPacket) Unpack 

func (p *PubrelPacket) Unpack(b io.Reader) (err error)

func (*PubrelPacket) Write 

func (p *PubrelPacket) Write(w io.Writer) (err error)

type SubackPacket 

type SubackPacket struct {
	FixedHeader
	MessageID   uint16
	ReturnCodes []byte
}

func (*SubackPacket) Name 

func (p *SubackPacket) Name() string

func (*SubackPacket) String 

func (p *SubackPacket) String() string

func (*SubackPacket) Type 

func (p *SubackPacket) Type() byte

func (*SubackPacket) Unpack 

func (p *SubackPacket) Unpack(b io.Reader) (err error)

func (*SubackPacket) Write 

func (p *SubackPacket) Write(w io.Writer) (err error)

type SubscribePacket 

type SubscribePacket struct {
	FixedHeader
	MessageID          uint16
	TopicSubscriptions []TopicSubscription
}

func (*SubscribePacket) Name 

func (p *SubscribePacket) Name() string

func (*SubscribePacket) String 

func (p *SubscribePacket) String() string

func (*SubscribePacket) Type 

func (p *SubscribePacket) Type() byte

func (*SubscribePacket) Unpack 

func (p *SubscribePacket) Unpack(b io.Reader) (err error)

func (*SubscribePacket) Write 

func (p *SubscribePacket) Write(w io.Writer) (err error)

type TopicSubscription 

type TopicSubscription struct {
	TopicFilter string
	Qos         byte
}

func (*TopicSubscription) String 

func (ts *TopicSubscription) String() string

type UnsubackPacket 

type UnsubackPacket struct {
	FixedHeader
	MessageID uint16
}

func (*UnsubackPacket) Name 

func (p *UnsubackPacket) Name() string

func (*UnsubackPacket) String 

func (p *UnsubackPacket) String() string

func (*UnsubackPacket) Type 

func (p *UnsubackPacket) Type() byte

func (*UnsubackPacket) Unpack 

func (p *UnsubackPacket) Unpack(b io.Reader) (err error)

func (*UnsubackPacket) Write 

func (p *UnsubackPacket) Write(w io.Writer) (err error)

type UnsubscribePacket 

type UnsubscribePacket struct {
	FixedHeader
	MessageID    uint16
	TopicFilters []string
}

func (*UnsubscribePacket) Name 

func (p *UnsubscribePacket) Name() string

func (*UnsubscribePacket) String 

func (p *UnsubscribePacket) String() string

func (*UnsubscribePacket) Type 

func (p *UnsubscribePacket) Type() byte

func (*UnsubscribePacket) Unpack 

func (p *UnsubscribePacket) Unpack(b io.Reader) (err error)

func (*UnsubscribePacket) Write 

func (p *UnsubscribePacket) Write(w io.Writer) (err error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.