packets

Documentation

Index

• Constants
• Variables
• type ConnackPacket
  • func (ca *ConnackPacket) Read(b io.Reader) error
  • func (ca *ConnackPacket) String() string
  • func (ca *ConnackPacket) Write(w io.Writer) error
• type ConnectPacket
  • func (cp *ConnectPacket) Read(b io.Reader) error
  • func (cp *ConnectPacket) String() string
  • func (c *ConnectPacket) Validate() byte
  • func (cp *ConnectPacket) Write(w io.Writer) error
• type DisconnectPacket
  • func (d *DisconnectPacket) Read(b io.Reader) error
  • func (d *DisconnectPacket) String() string
  • func (d *DisconnectPacket) Write(w io.Writer) error
• type FixedHeader
  • func (fh FixedHeader) String() string
• type MqttPacket
  • func NewMqttPacket(messageType byte) MqttPacket
  • func NewMqttPacketWithHeader(fh FixedHeader) (MqttPacket, error)
  • func ReadPacket(conn net.Conn) (MqttPacket, error)
• type PingreqPacket
  • func (pr *PingreqPacket) Read(b io.Reader) error
  • func (pr *PingreqPacket) String() string
  • func (pr *PingreqPacket) Write(w io.Writer) error
• type PingrespPacket
  • func (pr *PingrespPacket) Read(b io.Reader) error
  • func (pr *PingrespPacket) String() string
  • func (pr *PingrespPacket) Write(w io.Writer) error
• type PublishPacket
  • func (p *PublishPacket) Copy() *PublishPacket
  • func (p *PublishPacket) Read(b io.Reader) error
  • func (p *PublishPacket) String() string
  • func (p *PublishPacket) Write(w io.Writer) error
• type SubackPacket
  • func (sa *SubackPacket) Read(b io.Reader) error
  • func (sa *SubackPacket) String() string
  • func (sa *SubackPacket) Write(w io.Writer) error
• type SubscribePacket
  • func (s *SubscribePacket) Read(b io.Reader) error
  • func (s *SubscribePacket) String() string
  • func (s *SubscribePacket) Write(w io.Writer) error
• type UnsubackPacket
  • func (ua *UnsubackPacket) Read(b io.Reader) error
  • func (ua *UnsubackPacket) String() string
  • func (ua *UnsubackPacket) Write(w io.Writer) error
• type UnsubscribePacket
  • func (u *UnsubscribePacket) Read(b io.Reader) error
  • func (u *UnsubscribePacket) String() string
  • func (u *UnsubscribePacket) Write(w io.Writer) error

Constants

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
)

Mqtt消息的包类型

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

Variables

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",
}

Types

type ConnackPacket

type ConnackPacket struct {
	FixedHeader
	SessionPresent bool
	ReturnCode     byte
}

connack包，服务端对connect的回应

func (*ConnackPacket) Read

func (ca *ConnackPacket) Read(b io.Reader) error

func (*ConnackPacket) String

func (ca *ConnackPacket) String() string

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
	Keepalive       uint16

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

connect包，客户端发起连接时发送

func (*ConnectPacket) Read

func (cp *ConnectPacket) Read(b io.Reader) error

func (*ConnectPacket) String

func (cp *ConnectPacket) String() string

func (*ConnectPacket) Validate

func (c *ConnectPacket) Validate() byte

Validate performs validation of the fields of a Connect packet

func (*ConnectPacket) Write

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

type DisconnectPacket

type DisconnectPacket struct {
	FixedHeader
}

func (*DisconnectPacket) Read

func (d *DisconnectPacket) Read(b io.Reader) error

func (*DisconnectPacket) String

func (d *DisconnectPacket) String() string

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
}

MQTT协议的固定头部协议，每条消息都需要携带

func (FixedHeader) String

func (fh FixedHeader) String() string

type MqttPacket

type MqttPacket interface {
	Write(io.Writer) error
	Read(io.Reader) error
	String() string
}

所有packet的公共接口

func NewMqttPacket

func NewMqttPacket(messageType byte) MqttPacket

func NewMqttPacketWithHeader

func NewMqttPacketWithHeader(fh FixedHeader) (MqttPacket, error)

func ReadPacket

func ReadPacket(conn net.Conn) (MqttPacket, error)

type PingreqPacket

type PingreqPacket struct {
	FixedHeader
}

func (*PingreqPacket) Read

func (pr *PingreqPacket) Read(b io.Reader) error

func (*PingreqPacket) String

func (pr *PingreqPacket) String() string

func (*PingreqPacket) Write

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

type PingrespPacket

type PingrespPacket struct {
	FixedHeader
}

func (*PingrespPacket) Read

func (pr *PingrespPacket) Read(b io.Reader) error

func (*PingrespPacket) String

func (pr *PingrespPacket) String() string

func (*PingrespPacket) Write

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

type PublishPacket

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

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) Read

func (p *PublishPacket) Read(b io.Reader) error

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

func (*PublishPacket) String

func (p *PublishPacket) String() string

func (*PublishPacket) Write

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

type SubackPacket

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

func (*SubackPacket) Read

func (sa *SubackPacket) Read(b io.Reader) error

func (*SubackPacket) String

func (sa *SubackPacket) String() string

func (*SubackPacket) Write

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

type SubscribePacket

type SubscribePacket struct {
	FixedHeader
	MessageID uint16
	Topics    []string
	Qoss      []byte
}

func (*SubscribePacket) Read

func (s *SubscribePacket) Read(b io.Reader) error

func (*SubscribePacket) String

func (s *SubscribePacket) String() string

func (*SubscribePacket) Write

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

type UnsubackPacket

type UnsubackPacket struct {
	FixedHeader
	MessageID uint16
}

func (*UnsubackPacket) Read

func (ua *UnsubackPacket) Read(b io.Reader) error

func (*UnsubackPacket) String

func (ua *UnsubackPacket) String() string

func (*UnsubackPacket) Write

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

type UnsubscribePacket

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

func (*UnsubscribePacket) Read

func (u *UnsubscribePacket) Read(b io.Reader) error

func (*UnsubscribePacket) String

func (u *UnsubscribePacket) String() string

func (*UnsubscribePacket) Write

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