mqttClient

Documentation

Index

• type Client
• type ClientPool
  • func RunPool() (pool *ClientPool)
  • func (p *ClientPool) AddClient(client Client)
  • func (p *ClientPool) GetClientsByNames(clientNames []string) (clients []Client)
  • func (p *ClientPool) RemoveClient(client Client)
  • func (p *ClientPool) RunClients()
  • func (p *ClientPool) Shutdown()
• type ClientStruct
  • func (c *ClientStruct) AddRoute(subscribeTopic string, messageHandler MessageHandler)
  • func (c *ClientStruct) AvailabilityEnabled() bool
  • func (c *ClientStruct) GetAvailabilityTopic() string
  • func (c *ClientStruct) Name() string
  • func (c *ClientStruct) ReplaceTemplate(template string) string
• type ClientV5
  • func CreateV5(cfg Config, devicePoolInstance *device.DevicePool, ...) (client *ClientV5)
  • func (c *ClientV5) Run()
  • func (c *ClientV5) Shutdown()
• type Config
• type Message
  • func (m Message) Payload() []byte
  • func (m Message) Topic() string
• type MessageHandler
• type NumericRealtimeMessage
• type NumericTelemetryValue
• type TelemetryMessage
• type TextRealtimeMessage
• type TextTelemetryValue

Types

type Client

type Client interface {
	Name() string
	Run()
	Shutdown()
	ReplaceTemplate(template string) string
	AddRoute(subscribeTopic string, messageHandler MessageHandler)
}

type ClientPool

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

func RunPool

func RunPool() (pool *ClientPool)

func (*ClientPool) AddClient

func (p *ClientPool) AddClient(client Client)

func (*ClientPool) GetClientsByNames

func (p *ClientPool) GetClientsByNames(clientNames []string) (clients []Client)

func (*ClientPool) RemoveClient

func (p *ClientPool) RemoveClient(client Client)

func (*ClientPool) RunClients

func (p *ClientPool) RunClients()

func (*ClientPool) Shutdown

func (p *ClientPool) Shutdown()

type ClientStruct

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

func (*ClientStruct) AddRoute

func (c *ClientStruct) AddRoute(subscribeTopic string, messageHandler MessageHandler)

func (*ClientStruct) AvailabilityEnabled

func (c *ClientStruct) AvailabilityEnabled() bool

func (*ClientStruct) GetAvailabilityTopic

func (c *ClientStruct) GetAvailabilityTopic() string

func (*ClientStruct) Name

func (c *ClientStruct) Name() string

func (*ClientStruct) ReplaceTemplate

func (c *ClientStruct) ReplaceTemplate(template string) string

type ClientV5

type ClientV5 struct {
	ClientStruct
	// contains filtered or unexported fields
}

func CreateV5

func CreateV5(
	cfg Config,
	devicePoolInstance *device.DevicePool,
	storage *dataflow.ValueStorageInstance,
) (client *ClientV5)

func (*ClientV5) Run

func (c *ClientV5) Run()

func (*ClientV5) Shutdown

func (c *ClientV5) Shutdown()

type Config

type Config interface {
	Name() string
	Broker() *url.URL
	User() string
	Password() string
	ClientId() string
	Qos() byte
	KeepAlive() time.Duration
	ConnectRetryDelay() time.Duration
	ConnectTimeout() time.Duration
	AvailabilityTopic() string
	TelemetryInterval() time.Duration
	TelemetryTopic() string
	TelemetryRetain() bool
	RealtimeEnable() bool
	RealtimeTopic() string
	RealtimeRetain() bool
	TopicPrefix() string
	LogDebug() bool
	LogMessages() bool
}

type Message

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

func (Message) Payload

func (m Message) Payload() []byte

func (Message) Topic

func (m Message) Topic() string

type MessageHandler

type MessageHandler func(Message)

type NumericRealtimeMessage

type NumericRealtimeMessage struct {
	Time         string
	NumericValue float64
	Unit         string
}

type NumericTelemetryValue

type NumericTelemetryValue struct {
	Value float64
	Unit  string
}

type TelemetryMessage

type TelemetryMessage struct {
	Time                   string
	NextTelemetry          string
	Model                  string
	SecondsSinceLastUpdate float64
	NumericValues          map[string]NumericTelemetryValue
	TextValues             map[string]TextTelemetryValue
}

type TextRealtimeMessage

type TextRealtimeMessage struct {
	Time      string
	TextValue string
}

type TextTelemetryValue

type TextTelemetryValue struct {
	Value string
}