mqtt

package

v0.0.0-...-1a4e213 Latest Latest Go to latest Published: May 5, 2024 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func ClientID() string

ClientID created unique mqtt client id

type Client struct {
	Client paho.Client

	Qos byte
	// contains filtered or unexported fields
}

Client encapsulates mqtt publish/subscribe functions

var Instance *Client

Instance is the paho Mqtt client singleton

func NewClient(log *util.Logger, broker, user, password, clientID string, qos byte, insecure bool, opts ...Option) (*Client, error)

NewClient creates new Mqtt publisher

func RegisteredClient(log *util.Logger, broker, user, password, clientID string, qos byte, insecure bool, opts ...Option) (*Client, error)

RegisteredClient reuses an registered Mqtt publisher or creates a new one

func RegisteredClientOrDefault(log *util.Logger, cc Config) (*Client, error)

RegisteredClientOrDefault reuses an registered Mqtt publisher or creates a new one. If no publisher is configured, it uses the default instance.

func (m *Client) Cleanup(topic string, retained bool) error

Cleanup recursively removes a topic

func (m *Client) ConnectionHandler(client paho.Client)

ConnectionHandler restores listeners

func (m *Client) ConnectionLostHandler(client paho.Client, reason error)

ConnectionLostHandler logs cause of connection loss as warning

func (m *Client) Listen(topic string, callback func(string)) error

Listen attaches listener to slice of listeners for given topic

func (m *Client) ListenSetter(topic string, callback func(string) error) error

ListenSetter creates a /set listener that resets the payload after handling

func (m *Client) Publish(topic string, retained bool, payload interface{}) error

Publish synchronously publishes payload using client qos

func (m *Client) WaitForToken(action, topic string, token paho.Token)

WaitForToken synchronously waits until token operation completed

type Config struct {
	Broker   string
	User     string
	Password string
	ClientID string
	Insecure bool
}

Config is the public configuration

type Option func(*paho.ClientOptions)