gomqtt

README

MQTT Go client

• https://github.com/eclipse/paho.mqtt.golang

mqtt server 事件中心

• https://github.com/emqx/emqx erlang server

• https://github.com/mochi-mqtt golang server

• ${EMQX_TCP_PORT}:1883

• ${EMQX_SSL_PORT}:8883

• ${EMQX_WS_PORT}:8083

• ${EMQX_WSS_PORT}:8084

• ${EMQX_DASHBOARD_PORT}:18083

Documentation

Index

• Constants
• func Init(configs ...Config) (err error)
• type Config
• type GoMqttClient
  • func Client() *GoMqttClient
  • func GetClient(names ...string) *GoMqttClient
  • func NewClient(config Config) (*GoMqttClient, error)
  • func NewConfig(opts *mqtt.ClientOptions) (*GoMqttClient, error)
  • func (g *GoMqttClient) Connect() error
  • func (g *GoMqttClient) Disconnect(quiesce uint)
  • func (g *GoMqttClient) Publish(topic string, qos byte, retained bool, payload interface{}) error
  • func (g *GoMqttClient) Subscribe(topic string, qos byte, callback mqtt.MessageHandler) error
  • func (g *GoMqttClient) Unsubscribe(topics ...string) error

Constants

const (
	PROTOCOL_TCP = "tcp"
	PROTOCOL_SSL = "ssl"
	PROTOCOL_WS  = "ws"
	PROTOCOL_WSS = "wss"
)

Functions

func Init

func Init(configs ...Config) (err error)

Types

type Config

type Config struct {
	Name             string `yaml:"Name,optional" json:"name,optional"`
	Protocol         string `yaml:"Protocol,optional" json:"protocol,optional"`
	CaFilePath       string `yaml:"CaFilePath,optional" json:"caFilePath,optional"` //tls(ssl wss) 证书位置
	Server           string `yaml:"Server,optional" json:"server,optional"`
	Port             int    `yaml:"Port,optional" json:"port,optional"`
	ClientId         string `yaml:"ClientId,optional" json:"clientId,optional"`
	User             string `yaml:"User,optional" json:"user,optional"`
	Secret           string `yaml:"Secret,optional" json:"secret,optional"`
	KeepAlive        int64  `yaml:"KeepAlive,optional" json:"keepAlive,optional"` //s
	AutoReconnect    bool   `yaml:"AutoReconnect,optional" json:"autoReconnect,optional"`
	ConnectRetry     bool   `yaml:"ConnectRetry,optional" json:"connectRetry,optional"`
	ConnectTimeout   int64  `yaml:"ConnectTimeout,optional" json:"connectTimeout,optional"`
	DefaultHandler   *mqtt.MessageHandler
	OnConnect        *mqtt.OnConnectHandler
	OnConnectionLost *mqtt.ConnectionLostHandler
}

type GoMqttClient

type GoMqttClient struct {
	Client mqtt.Client
}

func Client

func Client() *GoMqttClient

func GetClient

func GetClient(names ...string) *GoMqttClient

func NewClient

func NewClient(config Config) (*GoMqttClient, error)

func NewConfig

func NewConfig(opts *mqtt.ClientOptions) (*GoMqttClient, error)

func (*GoMqttClient) Connect

func (g *GoMqttClient) Connect() error

func (*GoMqttClient) Disconnect

func (g *GoMqttClient) Disconnect(quiesce uint)

func (*GoMqttClient) Publish

func (g *GoMqttClient) Publish(topic string, qos byte, retained bool, payload interface{}) error

func (*GoMqttClient) Subscribe

func (g *GoMqttClient) Subscribe(topic string, qos byte, callback mqtt.MessageHandler) error

func (*GoMqttClient) Unsubscribe

func (g *GoMqttClient) Unsubscribe(topics ...string) error