packets

package
Version: v0.0.0-...-9cffdcc Latest Latest
Warning

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

Go to latest
Published: Jan 29, 2016 License: EPL-1.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

View Source
const (
	Connect     = 1
	Connack     = 2
	Publish     = 3
	Puback      = 4
	Pubrec      = 5
	Pubrel      = 6
	Pubcomp     = 7
	Subscribe   = 8
	Suback      = 9
	Unsubscribe = 10
	Unsuback    = 11
	Pingreq     = 12
	Pingresp    = 13
	Disconnect  = 14
)

Below are the constants assigned to each of the MQTT packet types

View Source
const (
	Accepted                        = 0x00
	ErrRefusedBadProtocolVersion    = 0x01
	ErrRefusedIDRejected            = 0x02
	ErrRefusedServerUnavailable     = 0x03
	ErrRefusedBadUsernameOrPassword = 0x04
	ErrRefusedNotAuthorised         = 0x05
	ErrNetworkError                 = 0xFE
	ErrProtocolViolation            = 0xFF
)

Below are the const definitions for error codes returned by Connect()

Variables

View Source
var ConnErrors = map[byte]error{
	Accepted:                        nil,
	ErrRefusedBadProtocolVersion:    errors.New("Unnacceptable protocol version"),
	ErrRefusedIDRejected:            errors.New("Identifier rejected"),
	ErrRefusedServerUnavailable:     errors.New("Server Unavailable"),
	ErrRefusedBadUsernameOrPassword: errors.New("Bad user name or password"),
	ErrRefusedNotAuthorised:         errors.New("Not Authorized"),
	ErrNetworkError:                 errors.New("Network Error"),
	ErrProtocolViolation:            errors.New("Protocol Violation"),
}

ConnErrors is a map of the errors codes constants for Connect() to a Go error

View Source
var ConnackReturnCodes = map[uint8]string{
	0:   "Connection Accepted",
	1:   "Connection Refused: Bad Protocol Version",
	2:   "Connection Refused: Client Identifier Rejected",
	3:   "Connection Refused: Server Unavailable",
	4:   "Connection Refused: Username or Password in unknown format",
	5:   "Connection Refused: Not Authorised",
	254: "Connection Error",
	255: "Connection Refused: Protocol Violation",
}

ConnackReturnCodes is a map of the error codes constants for Connect() to a string representation of the error

View Source
var PacketNames = map[uint8]string{
	1:  "CONNECT",
	2:  "CONNACK",
	3:  "PUBLISH",
	4:  "PUBACK",
	5:  "PUBREC",
	6:  "PUBREL",
	7:  "PUBCOMP",
	8:  "SUBSCRIBE",
	9:  "SUBACK",
	10: "UNSUBSCRIBE",
	11: "UNSUBACK",
	12: "PINGREQ",
	13: "PINGRESP",
	14: "DISCONNECT",
}

PacketNames maps the constants for each of the MQTT packet types to a string representation of their name.

Functions

This section is empty.

Types

type ConnackPacket

type ConnackPacket struct {
	FixedHeader
	TopicNameCompression byte
	ReturnCode           byte
	// contains filtered or unexported fields
}

ConnackPacket is an internal representation of the fields of the Connack MQTT packet

func (*ConnackPacket) Details

func (ca *ConnackPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*ConnackPacket) String

func (ca *ConnackPacket) String() string

func (*ConnackPacket) UUID

func (ca *ConnackPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*ConnackPacket) Unpack

func (ca *ConnackPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*ConnackPacket) Write

func (ca *ConnackPacket) Write(w io.Writer) error

type ConnectPacket

type ConnectPacket struct {
	FixedHeader
	ProtocolName    string
	ProtocolVersion byte
	CleanSession    bool
	WillFlag        bool
	WillQos         byte
	WillRetain      bool
	UsernameFlag    bool
	PasswordFlag    bool
	ReservedBit     byte
	KeepaliveTimer  uint16

	ClientIdentifier string
	WillTopic        string
	WillMessage      []byte
	Username         string
	Password         []byte
	// contains filtered or unexported fields
}

ConnectPacket is an internal representation of the fields of the Connect MQTT packet

func (*ConnectPacket) Details

func (c *ConnectPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*ConnectPacket) String

func (c *ConnectPacket) String() string

func (*ConnectPacket) UUID

func (c *ConnectPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*ConnectPacket) Unpack

func (c *ConnectPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*ConnectPacket) Validate

func (c *ConnectPacket) Validate() byte

Validate performs validation of the fields of a Connect packet

func (*ConnectPacket) Write

func (c *ConnectPacket) Write(w io.Writer) error

type ControlPacket

type ControlPacket interface {
	Write(io.Writer) error
	Unpack(io.Reader)
	String() string
	Details() Details
	UUID() uuid.UUID
}

ControlPacket defines the interface for structs intended to hold decoded MQTT packets, either from being read or before being written

func NewControlPacket

func NewControlPacket(packetType byte) (cp ControlPacket)

NewControlPacket is used to create a new ControlPacket of the type specified by packetType, this is usually done by reference to the packet type constants defined in packets.go. The newly created ControlPacket is empty and a pointer is returned.

func NewControlPacketWithHeader

func NewControlPacketWithHeader(fh FixedHeader) (cp ControlPacket)

NewControlPacketWithHeader is used to create a new ControlPacket of the type specified within the FixedHeader that is passed to the function. The newly created ControlPacket is empty and a pointer is returned.

func ReadPacket

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

ReadPacket takes an instance of an io.Reader (such as net.Conn) and attempts to read an MQTT packet from the stream. It returns a ControlPacket representing the decoded MQTT packet and an error. One of these returns will always be nil, a nil ControlPacket indicating an error occurred.

type Details

type Details struct {
	Qos       byte
	MessageID uint16
}

Details struct returned by the Details() function called on ControlPackets to present details of the Qos and MessageID of the ControlPacket

type DisconnectPacket

type DisconnectPacket struct {
	FixedHeader
	// contains filtered or unexported fields
}

DisconnectPacket is an internal representation of the fields of the Disconnect MQTT packet

func (*DisconnectPacket) Details

func (d *DisconnectPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*DisconnectPacket) String

func (d *DisconnectPacket) String() string

func (*DisconnectPacket) UUID

func (d *DisconnectPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*DisconnectPacket) Unpack

func (d *DisconnectPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*DisconnectPacket) Write

func (d *DisconnectPacket) Write(w io.Writer) error

type FixedHeader

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

FixedHeader is a struct to hold the decoded information from the fixed header of an MQTT ControlPacket

func (FixedHeader) String

func (fh FixedHeader) String() string

type PingreqPacket

type PingreqPacket struct {
	FixedHeader
	// contains filtered or unexported fields
}

PingreqPacket is an internal representation of the fields of the Pingreq MQTT packet

func (*PingreqPacket) Details

func (pr *PingreqPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*PingreqPacket) String

func (pr *PingreqPacket) String() string

func (*PingreqPacket) UUID

func (pr *PingreqPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*PingreqPacket) Unpack

func (pr *PingreqPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*PingreqPacket) Write

func (pr *PingreqPacket) Write(w io.Writer) error

type PingrespPacket

type PingrespPacket struct {
	FixedHeader
	// contains filtered or unexported fields
}

PingrespPacket is an internal representation of the fields of the Pingresp MQTT packet

func (*PingrespPacket) Details

func (pr *PingrespPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*PingrespPacket) String

func (pr *PingrespPacket) String() string

func (*PingrespPacket) UUID

func (pr *PingrespPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*PingrespPacket) Unpack

func (pr *PingrespPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*PingrespPacket) Write

func (pr *PingrespPacket) Write(w io.Writer) error

type PubackPacket

type PubackPacket struct {
	FixedHeader
	MessageID uint16
	// contains filtered or unexported fields
}

PubackPacket is an internal representation of the fields of the Puback MQTT packet

func (*PubackPacket) Details

func (pa *PubackPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*PubackPacket) String

func (pa *PubackPacket) String() string

func (*PubackPacket) UUID

func (pa *PubackPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*PubackPacket) Unpack

func (pa *PubackPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*PubackPacket) Write

func (pa *PubackPacket) Write(w io.Writer) error

type PubcompPacket

type PubcompPacket struct {
	FixedHeader
	MessageID uint16
	// contains filtered or unexported fields
}

PubcompPacket is an internal representation of the fields of the Pubcomp MQTT packet

func (*PubcompPacket) Details

func (pc *PubcompPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*PubcompPacket) String

func (pc *PubcompPacket) String() string

func (*PubcompPacket) UUID

func (pc *PubcompPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*PubcompPacket) Unpack

func (pc *PubcompPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*PubcompPacket) Write

func (pc *PubcompPacket) Write(w io.Writer) error

type PublishPacket

type PublishPacket struct {
	FixedHeader
	TopicName string
	MessageID uint16
	Payload   []byte
	// contains filtered or unexported fields
}

PublishPacket is an internal representation of the fields of the Publish MQTT packet

func (*PublishPacket) Copy

func (p *PublishPacket) Copy() *PublishPacket

Copy creates a new PublishPacket with the same topic and payload but an empty fixed header, useful for when you want to deliver a message with different properties such as Qos but the same content

func (*PublishPacket) Details

func (p *PublishPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*PublishPacket) String

func (p *PublishPacket) String() string

func (*PublishPacket) UUID

func (p *PublishPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*PublishPacket) Unpack

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

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*PublishPacket) Write

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

type PubrecPacket

type PubrecPacket struct {
	FixedHeader
	MessageID uint16
	// contains filtered or unexported fields
}

PubrecPacket is an internal representation of the fields of the Pubrec MQTT packet

func (*PubrecPacket) Details

func (pr *PubrecPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*PubrecPacket) String

func (pr *PubrecPacket) String() string

func (*PubrecPacket) UUID

func (pr *PubrecPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*PubrecPacket) Unpack

func (pr *PubrecPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*PubrecPacket) Write

func (pr *PubrecPacket) Write(w io.Writer) error

type PubrelPacket

type PubrelPacket struct {
	FixedHeader
	MessageID uint16
	// contains filtered or unexported fields
}

PubrelPacket is an internal representation of the fields of the Pubrel MQTT packet

func (*PubrelPacket) Details

func (pr *PubrelPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*PubrelPacket) String

func (pr *PubrelPacket) String() string

func (*PubrelPacket) UUID

func (pr *PubrelPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*PubrelPacket) Unpack

func (pr *PubrelPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*PubrelPacket) Write

func (pr *PubrelPacket) Write(w io.Writer) error

type SubackPacket

type SubackPacket struct {
	FixedHeader
	MessageID   uint16
	GrantedQoss []byte
	// contains filtered or unexported fields
}

SubackPacket is an internal representation of the fields of the Suback MQTT packet

func (*SubackPacket) Details

func (sa *SubackPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*SubackPacket) String

func (sa *SubackPacket) String() string

func (*SubackPacket) UUID

func (sa *SubackPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*SubackPacket) Unpack

func (sa *SubackPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*SubackPacket) Write

func (sa *SubackPacket) Write(w io.Writer) error

type SubscribePacket

type SubscribePacket struct {
	FixedHeader
	MessageID uint16
	Topics    []string
	Qoss      []byte
	// contains filtered or unexported fields
}

SubscribePacket is an internal representation of the fields of the Subscribe MQTT packet

func (*SubscribePacket) Details

func (s *SubscribePacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*SubscribePacket) String

func (s *SubscribePacket) String() string

func (*SubscribePacket) UUID

func (s *SubscribePacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*SubscribePacket) Unpack

func (s *SubscribePacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*SubscribePacket) Write

func (s *SubscribePacket) Write(w io.Writer) error

type UnsubackPacket

type UnsubackPacket struct {
	FixedHeader
	MessageID uint16
	// contains filtered or unexported fields
}

UnsubackPacket is an internal representation of the fields of the Unsuback MQTT packet

func (*UnsubackPacket) Details

func (ua *UnsubackPacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*UnsubackPacket) String

func (ua *UnsubackPacket) String() string

func (*UnsubackPacket) UUID

func (ua *UnsubackPacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*UnsubackPacket) Unpack

func (ua *UnsubackPacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*UnsubackPacket) Write

func (ua *UnsubackPacket) Write(w io.Writer) error

type UnsubscribePacket

type UnsubscribePacket struct {
	FixedHeader
	MessageID uint16
	Topics    []string
	// contains filtered or unexported fields
}

UnsubscribePacket is an internal representation of the fields of the Unsubscribe MQTT packet

func (*UnsubscribePacket) Details

func (u *UnsubscribePacket) Details() Details

Details returns a Details struct containing the Qos and MessageID of this ControlPacket

func (*UnsubscribePacket) String

func (u *UnsubscribePacket) String() string

func (*UnsubscribePacket) UUID

func (u *UnsubscribePacket) UUID() uuid.UUID

UUID returns the unique ID assigned to the ControlPacket when it was originally received. Note: this is not related to the MessageID field for MQTT packets

func (*UnsubscribePacket) Unpack

func (u *UnsubscribePacket) Unpack(b io.Reader)

Unpack decodes the details of a ControlPacket after the fixed header has been read

func (*UnsubscribePacket) Write

func (u *UnsubscribePacket) Write(w io.Writer) error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL