mqtt_bridge

README

MQTT BRIDGE Plugin

Documentation

Index

• Constants
• Variables
• func New() supervisor.Pluggable
• func NewSettings() m.Attributes
• func NewStates() (states map[string]supervisor.ActorState)
• type Actor
  • func NewActor(entity *m.Entity, service supervisor.Service) (actor *Actor)
  • func (e *Actor) Destroy()
  • func (e *Actor) SetState(params supervisor.EntityStateParams) error
  • func (e *Actor) Spawn()
• type Config
• type Direction
• type MqttBridge
  • func NewMqttBridge(cfg *Config, server mqtt.MqttServ, actor *Actor) (bridge *MqttBridge, err error)
  • func (m *MqttBridge) Shutdown(ctx context.Context) (err error)
  • func (m *MqttBridge) Start(ctx context.Context) (err error)

Constants

const (
	// Name ...
	Name = "mqtt_bridge"
	// FuncEntityAction ...
	FuncEntityAction = "entityAction"

	Version = "0.0.1"
)

const (
	DirectionIn   = Direction("in")
	DirectionOut  = Direction("out")
	DirectionBoth = Direction("both")
)

const (
	AttrConnected = "connected"
	AttrOffline   = "offline"

	AttrKeepAlive      = "keepAlive"
	AttrPingTimeout    = "pingTimeout"
	AttrBroker         = "broker"
	AttrClientID       = "clientID"
	AttrConnectTimeout = "connectTimeout"
	AttrCleanSession   = "cleanSession"
	AttrUsername       = "username"
	AttrPassword       = "password"
	AttrQos            = "qos"
	AttrDirection      = "direction"
	AttrTopics         = "topics"
)

Variables

var F embed.FS

Functions

func New

func New() supervisor.Pluggable

New ...

func NewSettings

func NewSettings() m.Attributes

NewSettings ...

func NewStates

func NewStates() (states map[string]supervisor.ActorState)

NewStates ...

Types

type Actor

type Actor struct {
	*supervisor.BaseActor
	// contains filtered or unexported fields
}

Actor ...

func NewActor

func NewActor(entity *m.Entity,
	service supervisor.Service) (actor *Actor)

NewActor ...

func (*Actor) Destroy

func (e *Actor) Destroy()

func (*Actor) SetState

func (e *Actor) SetState(params supervisor.EntityStateParams) error

SetState ...

func (*Actor) Spawn

func (e *Actor) Spawn()

Spawn ...

type Config

type Config struct {
	KeepAlive      int
	PingTimeout    int
	Broker         string
	ClientID       string
	ConnectTimeout int
	CleanSession   bool
	Username       string
	Password       string
	Qos            byte
	Direction      Direction
	Topics         []string
}

Config ...

type Direction

type Direction string

type MqttBridge

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

func NewMqttBridge

func NewMqttBridge(cfg *Config, server mqtt.MqttServ, actor *Actor) (bridge *MqttBridge, err error)

func (*MqttBridge) Shutdown

func (m *MqttBridge) Shutdown(ctx context.Context) (err error)

func (*MqttBridge) Start

func (m *MqttBridge) Start(ctx context.Context) (err error)