mqtt

Documentation

Overview

Package mqtt provides functionalities to handle the client connection to the broker using MQTT

Package mqtt provides functionalities to handle the client connection to the broker using MQTT

Index

• func SetClient(client *Client)
• func StartMQTTClient(brokerURL string)
• type Client
  • func GetClient() *Client
  • func NewClient(configs ...Config) (*Client, error)
  • func (client *Client) Connect() error
  • func (client *Client) Disconnect(quiesce uint)
  • func (client *Client) IsConnected() bool
  • func (client *Client) Publish(message Message, topic string) error
  • func (c *Client) SetBrokerURL(protocol string) string
• type Config
  • func SetClientID(id string) Config
  • func SetHost(host string) Config
  • func SetPort(port uint) Config
• type Message

Functions

func SetClient

func SetClient(client *Client)

SetClient sets the client

func StartMQTTClient

func StartMQTTClient(brokerURL string)

StartMQTTClient is used to initiate the client and set the configuration

Types

type Client

type Client struct {
	ID   string
	Host string
	Port uint
	Qos  byte
	sync.RWMutex
	ClientOptions *MQTT.ClientOptions
	MQTT.Client
}

Client is a wrapper on top of `MQTT.Client`

func GetClient

func GetClient() *Client

GetClient gets the client set

func NewClient

func NewClient(configs ...Config) (*Client, error)

NewClient returns a configured `Client`. Is mandatory

func (*Client) Connect

func (client *Client) Connect() error

Connect creates a new mqtt client and uses the ClientOptions generated in the NewClient function to connect with the provided host and port.

func (*Client) Disconnect

func (client *Client) Disconnect(quiesce uint)

Disconnect disconnects the connection

func (*Client) IsConnected

func (client *Client) IsConnected() bool

IsConnected checks if the client is connected or not

func (*Client) Publish

func (client *Client) Publish(message Message, topic string) error

Publish is used to publish the client data to the cloud

func (*Client) SetBrokerURL

func (c *Client) SetBrokerURL(protocol string) string

SetBrokerURL returns the broker url for connection

type Config

type Config func(*Client)

Config represents an attribute config setter for the `Client`.

func SetClientID

func SetClientID(id string) Config

SetClientID sets the mqtt client id.

func SetHost

func SetHost(host string) Config

SetHost sets the host where to connect.

func SetPort

func SetPort(port uint) Config

SetPort sets the port where to connect.

type Message

type Message struct {
	AppID   string
	Payload string
}

Message is used to wrap the app id and payload into one and publish to broker