mqtt

package module
v0.0.0-...-37a47c3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 27, 2022 License: MIT Imports: 2 Imported by: 0

README

mqtt

管理MQTT的连接,以及消息的订阅。

使用

首先生成配置:

import "gitee.com/xiaochengtech/mqtt"

conf := mqtt.Config{
	Broker:   "tcp://127.0.0.1:1883",
	ClientID: "client001",
}

然后生成一个全局的实例,注册需要订阅的消息,连接后会自动订阅:

import (
    "gitee.com/xiaochengtech/mqtt"
    gomqtt "github.com/eclipse/paho.mqtt.golang"
)

var instance = mqtt.Client{}

func init() {
    instance.Subscribe(mqtt.SubscribeType{ // 消息订阅
        Topic:      "topic/test",
        Qos:        byte(0),
        Callback:   TestMessageHandler,
        RetryTimes: 0,
    })
}

// TestMessageHandler函数定义格式如下
func TestMessageHandler(client gomqtt.Client, message gomqtt.Message) {
    // ...
}

其中RetryTimes表示订阅失败后的重试次数,如果为0,则表示一直重试下去。

最后使用初始化方法连接到MQTT的Broker上:

opts := mqtt.GetClientOptions(&conf)
opts.Username = "username"
opts.Password = "password"
opts.SetWill(topic, "client_dead", 0, true)
opts.SetKeepAlive(10 * time.Second)
opts.SetPingTimeout(5 * time.Second)
// ...
opts.SetOnConnectHandler(...) // 设置自定义的连接后处理方法
opts.SetConnectionLostHandler(...) // 设置自定义的断开连接后处理方法
if err := instance.Init(opts); err != nil {
    log.Fatal("初始化失败")
} else {
    log.Println("初始化成功")
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetClient

func GetClient(opts *gomqtt.ClientOptions) (client gomqtt.Client, err error)

获取MQTT连接

func GetClientOptions

func GetClientOptions(conf *Config) *gomqtt.ClientOptions

获取MQTT连接配置项

Types

type Client

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

MQTT连接

func (*Client) Close

func (m *Client) Close()

关闭监视器

func (*Client) Init

func (m *Client) Init(opts *gomqtt.ClientOptions) (err error)

初始化监听器

func (Client) Publish

func (m Client) Publish(topic string, payload interface{}, qos byte, retained bool) (err error)

通用发布消息接口

func (*Client) Subscribe

func (m *Client) Subscribe(item SubscribeType)

注册订阅消息

type Config

type Config struct {
	Broker   string `json:"Broker"`   // Broker地址,例如tcp://127.0.0.1:1883
	ClientID string `json:"ClientID"` // ClientID
}

MQTT的配置信息格式

type SubscribeType

type SubscribeType struct {
	Topic      string
	Qos        byte
	Callback   gomqtt.MessageHandler
	RetryTimes int // 为0表示无限重试
}

Jump to

Keyboard shortcuts

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