publisher

package

v0.0.0-...-31e8ef2 Latest Latest Go to latest Published: Jul 27, 2020 License: MIT Imports: 9 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

View Source

const (
	// MQTTQOSOne is a constant representing QOS level 1 when publishing.
	MQTTQOSOne = byte(1)
)

View Source

var (
	// ErrPublishTimeout should only happen if the broker is unresponsive.
	ErrPublishTimeout = errors.New("mqtt publish timed out")
)

This section is empty.

type MQTTOptions struct {
	Topic       string
	Telemetry   string
	Broker      string
	ClientID    string
	TLSKeyFile  string
	TLSCertFile string
}

MQTTOptions controls how the internal mqtt client is created.

type MQTTPublisher struct {
	// contains filtered or unexported fields
}

MQTTPublisher knows how to Publish a collect.Msg to a given topic on its connected broker.

func NewMQTT(o MQTTOptions) *MQTTPublisher

NewMQTT creates an MQTTPublisher from the given options.

func (m *MQTTPublisher) Close()

Close disconnects from the broker.

func (m *MQTTPublisher) Connect(ctx context.Context) error

Connect initiates a client MQTT connection to the configured broker.

func (m *MQTTPublisher) Publish(ctx context.Context, msg *collect.Msg) error

Publish encodes a collect.Msg into json and sends it to the broker with QoS level 1.