mqtt

package module

v1.18.0 Latest Latest Go to latest Published: May 4, 2024 License: MIT Imports: 6 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ralvescosta/gokit

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func LogMessage(msg ...string) string
func NewMQTTError(msg string) error
func ValidateQoS(qos QoS) bool
type Handler
type MQTTClient
- func NewMQTTClient(cfgs *configs.Configs, logger logging.Logger) MQTTClient
type MQTTDispatcher
- func NewMQTTDispatcher(logger logging.Logger, client myQTT.Client) MQTTDispatcher
type MQTTError
- func (e *MQTTError) Error() string
type MQTTPublisher
- func NewMQTTPublisher(logger logging.Logger, client myQTT.Client) MQTTPublisher
type QoS
- func QoSFromBytes(qos byte) QoS

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ConnectionFailureError = NewMQTTError("connection failure")
	EmptyTopicError        = NewMQTTError("subscribe top cannot be empty string")
	NillHandlerError       = NewMQTTError("subscribe handler cannot be nil")
	NillPayloadError       = NewMQTTError("publish payload cannot be nil")
	InvalidQoSError        = NewMQTTError("qos must be one of: byte(0), byte(1) or byte(2)")
)

Functions ¶

func LogMessage ¶

func LogMessage(msg ...string) string

func NewMQTTError ¶

func NewMQTTError(msg string) error

func ValidateQoS ¶

func ValidateQoS(qos QoS) bool

Types ¶

type Handler ¶

type Handler = func(topic string, qos QoS, payload []byte) error

type MQTTClient ¶ added in v1.17.0

type MQTTClient interface {
	Connect() error
	Client() myQTT.Client
}

func NewMQTTClient ¶

func NewMQTTClient(cfgs *configs.Configs, logger logging.Logger) MQTTClient

type MQTTDispatcher ¶

type MQTTDispatcher interface {
	Register(topic string, qos QoS, handler Handler) error
	ConsumeBlocking(ch chan os.Signal)
}

func NewMQTTDispatcher ¶ added in v1.17.0

func NewMQTTDispatcher(logger logging.Logger, client myQTT.Client) MQTTDispatcher

type MQTTError ¶

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

func (*MQTTError) Error ¶

func (e *MQTTError) Error() string

type MQTTPublisher ¶

type MQTTPublisher interface {
	Pub(topic string, qos QoS, payload any) error
	PubRetained(topic string, qos QoS, payload any) error
}

func NewMQTTPublisher ¶

func NewMQTTPublisher(logger logging.Logger, client myQTT.Client) MQTTPublisher

type QoS ¶

type QoS byte

var (
	AtMostOnce  QoS = 0
	AtLeastOnce QoS = 1
	ExactlyOnce QoS = 2
)

func QoSFromBytes ¶

func QoSFromBytes(qos byte) QoS

Source Files ¶

View all Source files

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