mqtt

Documentation

Index

• type Client
  • func NewClient(mqtt *Mqtt, name string) *Client
  • func (m *Client) OnMsgArrived(ctx context.Context, client gmqtt.Client, msg packets.Message)
  • func (m *Client) Publish(topic string, payload []byte) (err error)
  • func (m *Client) Subscribe(topic string, handler MessageHandler) (err error)
  • func (m *Client) Unsubscribe(topic string)
  • func (m *Client) UnsubscribeAll()
• type IMQTT
• type IManagement
• type Message
• type MessageHandler
• type Mqtt
  • func NewMqtt(cfg *MqttConfig, graceful *graceful_service.GracefulService, ...) (mqtt *Mqtt)
  • func (m *Mqtt) Management() IManagement
  • func (m *Mqtt) NewClient(name string) (client *Client)
  • func (m *Mqtt) OnConnect(ctx context.Context, client gmqtt.Client) (code uint8)
  • func (m *Mqtt) OnMsgArrived(ctx context.Context, client gmqtt.Client, msg packets.Message) (valid bool)
  • func (m *Mqtt) Publish(topic string, payload []byte, qos uint8, retain bool) (err error)
  • func (m *Mqtt) Shutdown()
• type MqttBind
  • func NewMqttBind(mqtt *Mqtt) *MqttBind
  • func (m MqttBind) Publish(topic string, payload []byte, qos uint8, retain bool)
• type MqttConfig
  • func NewMqttConfig(cfg *config.AppConfig) *MqttConfig

Types

type Client

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

Client ...

func NewClient

func NewClient(mqtt *Mqtt, name string) *Client

NewClient ...

func (*Client) OnMsgArrived

func (m *Client) OnMsgArrived(ctx context.Context, client gmqtt.Client, msg packets.Message)

OnMsgArrived ...

func (*Client) Publish

func (m *Client) Publish(topic string, payload []byte) (err error)

Publish ...

func (*Client) Subscribe

func (m *Client) Subscribe(topic string, handler MessageHandler) (err error)

Subscribe ...

func (*Client) Unsubscribe

func (m *Client) Unsubscribe(topic string)

Unsubscribe ...

func (*Client) UnsubscribeAll

func (m *Client) UnsubscribeAll()

UnsubscribeAll ...

type IMQTT

type IMQTT interface {
	Run()
	Stop(ctx context.Context) error
	// SubscriptionStore returns the subscription.Store.
	SubscriptionStore() subscription.Store
	// RetainedStore returns the retained.Store.
	RetainedStore() retained.Store
	// PublishService returns the PublishService
	PublishService() gmqtt.PublishService
	// Client return the client specified by clientID.
	Client(clientID string) gmqtt.Client
	// GetConfig returns the config of the server
	GetConfig() gmqtt.Config
	// GetStatsManager returns StatsManager
	GetStatsManager() gmqtt.StatsManager
}

IMQTT ...

type IManagement

type IManagement interface {
	GetClients(limit, offset int) (list []*management.ClientInfo, total int, err error)
	GetClient(clientId string) (client *management.ClientInfo, err error)
	GetSessions(limit, offset int) (list []*management.SessionInfo, total int, err error)
	GetSession(clientId string) (session *management.SessionInfo, err error)
	GetSubscriptions(clientId string, limit, offset int) (list []*management.SubscriptionInfo, total int, err error)
	Subscribe(clientId, topic string, qos int) (err error)
	Unsubscribe(clientId, topic string) (err error)
	Publish(topic string, qos int, payload []byte, retain bool) (err error)
	CloseClient(clientId string) (err error)
	SearchTopic(query string) (result []*management.SubscriptionInfo, err error)
}

IManagement ...

type Message

type Message struct {
	Dup      bool
	Qos      uint8
	Retained bool
	Topic    string
	PacketID uint16
	Payload  []byte
}

Message ...

type MessageHandler

type MessageHandler func(*Client, Message)

MessageHandler ...

type Mqtt

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

Mqtt ...

func NewMqtt

func NewMqtt(cfg *MqttConfig,
	graceful *graceful_service.GracefulService,
	authenticator *mqtt_authenticator.Authenticator,
	scriptService *scripts.ScriptService,
	metric *metrics.MetricManager) (mqtt *Mqtt)

NewMqtt ...

func (*Mqtt) Management

func (m *Mqtt) Management() IManagement

Management ...

func (*Mqtt) NewClient

func (m *Mqtt) NewClient(name string) (client *Client)

NewClient ...

func (*Mqtt) OnConnect

func (m *Mqtt) OnConnect(ctx context.Context, client gmqtt.Client) (code uint8)

OnConnect ...

func (*Mqtt) OnMsgArrived

func (m *Mqtt) OnMsgArrived(ctx context.Context, client gmqtt.Client, msg packets.Message) (valid bool)

OnMsgArrived ...

func (*Mqtt) Publish

func (m *Mqtt) Publish(topic string, payload []byte, qos uint8, retain bool) (err error)

Publish ...

func (*Mqtt) Shutdown

func (m *Mqtt) Shutdown()

Shutdown ...

type MqttBind

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

Javascript Binding

Mqtt

.Publish

func NewMqttBind

func NewMqttBind(mqtt *Mqtt) *MqttBind

NewMqttBind ...

func (MqttBind) Publish

func (m MqttBind) Publish(topic string, payload []byte, qos uint8, retain bool)

Publish ...

type MqttConfig

type MqttConfig struct {
	Port                       int
	RetryInterval              time.Duration
	RetryCheckInterval         time.Duration
	SessionExpiryInterval      time.Duration
	SessionExpireCheckInterval time.Duration
	QueueQos0Messages          bool
	MaxInflight                int
	MaxAwaitRel                int
	MaxMsgQueue                int
	Logging                    bool
	DebugMode                  config.RunMode
}

MqttConfig ...

func NewMqttConfig

func NewMqttConfig(cfg *config.AppConfig) *MqttConfig

NewMqttConfig ...