mqtt

Documentation

Overview

Package mqtt implements the MQTT provider using the mqtt driver.

Index

• func OpenConnection(ctx context.Context, settings Settings, topics provider.Topics) (pc *provider.Connection, err error)
• func OpenSubscription(ctx context.Context, client mqtt.Client, topicName string, qos byte) (*pubsub.Subscription, error)
• func OpenTopic(client mqtt.Client, topicName string, qos byte) (*pubsub.Topic, error)
• type HTTPHeadersProvider
• type Settings

Functions

func OpenConnection

func OpenConnection(ctx context.Context, settings Settings, topics provider.Topics) (pc *provider.Connection, err error)

OpenConnection opens a MQTT connection using the given settings.

func OpenSubscription

func OpenSubscription(ctx context.Context, client mqtt.Client, topicName string, qos byte) (*pubsub.Subscription, error)

OpenSubscription returns a *pubsub.Subscription that subscribes to the given topic name with the given MQTT client.

func OpenTopic

func OpenTopic(client mqtt.Client, topicName string, qos byte) (*pubsub.Topic, error)

OpenTopic returns a *pubsub.Topic that publishes to the given topic name with the given MQTT client.

Types

type HTTPHeadersProvider

type HTTPHeadersProvider func(context.Context) (headers http.Header, err error)

HTTPHeadersProvider provides HTTP headers as they are needed by the MQTT client.

type Settings

type Settings struct {
	URL,
	ClientID,
	Username,
	Password string
	TLS                 *tls.Config
	HTTPHeadersProvider HTTPHeadersProvider
	PublishQoS,
	SubscribeQoS byte
	WebSocketReadBufferSize,
	WebSocketWriteBufferSize int
}

Settings configure the MQTT client.