mqtt

package

v0.0.0-...-9b9f36b Latest Latest Go to latest Published: Jun 7, 2016 License: MIT Imports: 10 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

Repository

github.com/zubairhamed/ttn

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
type ActivationHandler
type Client
- func NewClient(ctx log.Interface, id, username, password string, brokers ...string) Client
type DeviceTopic
- func ParseDeviceTopic(topic string) (*DeviceTopic, error)
- func (t DeviceTopic) String() string
type DeviceTopicType
type DownlinkHandler
type Token
type UplinkHandler

Constants ¶

View Source

const QoS = 0x02

Variables ¶

View Source

var (
	// ConnectRetries says how many times the client should retry a failed connection
	ConnectRetries = 10
	// ConnectRetryDelay says how long the client should wait between retries
	ConnectRetryDelay = time.Second
)

Functions ¶

This section is empty.

Types ¶

type ActivationHandler ¶

type ActivationHandler func(client Client, appEUI types.AppEUI, devEUI types.DevEUI, req core.OTAAAppReq)

type Client ¶

type Client interface {
	Connect() error
	Disconnect()

	IsConnected() bool

	// Uplink pub/sub
	PublishUplink(appEUI types.AppEUI, devEUI types.DevEUI, payload core.DataUpAppReq) Token
	SubscribeDeviceUplink(appEUI types.AppEUI, devEUI types.DevEUI, handler UplinkHandler) Token
	SubscribeAppUplink(appEUI types.AppEUI, handler UplinkHandler) Token
	SubscribeUplink(handler UplinkHandler) Token

	// Downlink pub/sub
	PublishDownlink(appEUI types.AppEUI, devEUI types.DevEUI, payload core.DataDownAppReq) Token
	SubscribeDeviceDownlink(appEUI types.AppEUI, devEUI types.DevEUI, handler DownlinkHandler) Token
	SubscribeAppDownlink(appEUI types.AppEUI, handler DownlinkHandler) Token
	SubscribeDownlink(handler DownlinkHandler) Token

	// Activation pub/sub
	PublishActivation(appEUI types.AppEUI, devEUI types.DevEUI, payload core.OTAAAppReq) Token
	SubscribeDeviceActivations(appEUI types.AppEUI, devEUI types.DevEUI, handler ActivationHandler) Token
	SubscribeAppActivations(appEUI types.AppEUI, handler ActivationHandler) Token
	SubscribeActivations(handler ActivationHandler) Token
}

Client connects to the MQTT server and can publish/subscribe on uplink, downlink and activations from devices

func NewClient ¶

func NewClient(ctx log.Interface, id, username, password string, brokers ...string) Client

type DeviceTopic ¶

type DeviceTopic struct {
	AppEUI types.AppEUI
	DevEUI types.DevEUI
	Type   DeviceTopicType
}

DeviceTopic represents an MQTT topic for application devices If the DevEUI is an empty []byte{}, it is considered to be a wildcard

func ParseDeviceTopic ¶

func ParseDeviceTopic(topic string) (*DeviceTopic, error)

ParseDeviceTopic parses an MQTT device topic string to a DeviceTopic struct

func (DeviceTopic) String ¶

func (t DeviceTopic) String() string

String implements the Stringer interface

type DeviceTopicType ¶

type DeviceTopicType string

DeviceTopicType represents the type of a device topic

const (
	// Activations of devices
	Activations DeviceTopicType = "activations"
	// Uplink data from devices
	Uplink DeviceTopicType = "up"
	// Downlink data to devices
	Downlink DeviceTopicType = "down"
)

type DownlinkHandler ¶

type DownlinkHandler func(client Client, appEUI types.AppEUI, devEUI types.DevEUI, req core.DataDownAppReq)

type Token ¶

type Token interface {
	Wait() bool
	WaitTimeout(time.Duration) bool
	Error() error
}

type UplinkHandler ¶

type UplinkHandler func(client Client, appEUI types.AppEUI, devEUI types.DevEUI, req core.DataUpAppReq)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL