mqtt_helper

README

mqtt-helper-go

Helper for MQTT

Documentation

Index

• func NewMQTTClient(opts *NewMQTTClientOptions) (*mqtt.Client, error)
• func Publish(client *mqtt.Client, topic string, qos byte, payload []byte) error
• func Subscribe(client *mqtt.Client, topic string, qos byte, ...) error
• type NewMQTTClientOptions
• type PasswordEncryptor
  • func NewHmacSha1Encryptor(key string) PasswordEncryptor
• type UsernameTransformer
  • func NewAwsIotUsernameTransformer(customAuthName string) UsernameTransformer

Functions

func NewMQTTClient

func NewMQTTClient(opts *NewMQTTClientOptions) (*mqtt.Client, error)

func Publish

func Publish(client *mqtt.Client, topic string, qos byte, payload []byte) error

func Subscribe

func Subscribe(client *mqtt.Client, topic string, qos byte, handler func(message mqtt.Message)) error

Types

type NewMQTTClientOptions

type NewMQTTClientOptions struct {
	UsernameTransformer   UsernameTransformer                 // optional, username transformer
	PasswordEncryptor     PasswordEncryptor                   // optional, password custom encryptor; default is no encrypt
	Brokers               []string                            // required, MQTT broker address
	ClientID              string                              // required, MQTT client ID
	Username              string                              // required, MQTT username
	Password              string                              // required, MQTT password
	ALPN                  []string                            // optional, MQTT ALPN
	ConnectionLostHandler func(client mqtt.Client, err error) // optional, connection lost handler
}

type PasswordEncryptor

type PasswordEncryptor func(originalPassword string) (encryptedPassword string, err error)

func NewHmacSha1Encryptor

func NewHmacSha1Encryptor(key string) PasswordEncryptor

type UsernameTransformer

type UsernameTransformer func(originalUsername string) (transformedUsername string, err error)

func NewAwsIotUsernameTransformer

func NewAwsIotUsernameTransformer(customAuthName string) UsernameTransformer