mqtt

package module

Go to main page

Versions in this module

v1

v1.3.8

Jan 13, 2022

Changes in this version

type Client

+ SetConnectHandler func(onConn ConnectHandler)

+ SetConnectionLostHandler func(onLost ConnectionLostHandler)

v1.3.7

Jan 13, 2022

Changes in this version

+ type ConnectHandler interface

+ HandleConnect func(Client)

type ConnectionLostHandler

+ HandleConnectionLost func(Client, error)

v1.3.6

Nov 29, 2021

Changes in this version

+ const ROU

+ func ConnectMQTT(conn net.Conn, cm *packets.ConnectPacket, protocolVersion uint) (byte, bool)

+ func NewWebsocket(host string, tlsc *tls.Config, timeout time.Duration, ...) (net.Conn, error)

type ClientOptions

+ ConnectRetry bool

+ ConnectRetryInterval time.Duration

+ OnConnectAttempt ConnectionAttemptHandler

+ OnReconnecting ReconnectHandler

+ WebsocketOptions *WebsocketOptions

+ func (o *ClientOptions) SetConnectRetry(a bool) *ClientOptions

+ func (o *ClientOptions) SetConnectRetryInterval(t time.Duration) *ClientOptions

+ func (o *ClientOptions) SetConnectionAttemptHandler(onConnectAttempt ConnectionAttemptHandler) *ClientOptions

+ func (o *ClientOptions) SetReconnectingHandler(cb ReconnectHandler) *ClientOptions

+ func (o *ClientOptions) SetWebsocketOptions(w *WebsocketOptions) *ClientOptions

type ClientOptionsReader

+ func (r *ClientOptionsReader) ConnectRetry() bool

+ func (r *ClientOptionsReader) ConnectRetryInterval() time.Duration

+ func (r *ClientOptionsReader) WebsocketOptions() *WebsocketOptions

type ConnectToken

+ func (b *ConnectToken) Done() <-chan struct{}

+ type ConnectionAttemptHandler func(broker *url.URL, tlsCfg *tls.Config) *tls.Config

type DisconnectToken

+ func (b *DisconnectToken) Done() <-chan struct{}

type DummyToken

+ func (d *DummyToken) Done() <-chan struct{}

type MessageHandler

+ HandleMessage func(Client, Message)

+ type PlaceHolderToken struct

+ func (p *PlaceHolderToken) Done() <-chan struct{}

+ func (p *PlaceHolderToken) Error() error

+ func (p *PlaceHolderToken) Wait() bool

+ func (p *PlaceHolderToken) WaitTimeout(t time.Duration) bool

+ type ProxyFunction func(req *http.Request) (*url.URL, error)

type PublishToken

+ func (b *PublishToken) Done() <-chan struct{}

+ type ReconnectHandler func(Client, *ClientOptions)

type SubscribeToken

+ func (b *SubscribeToken) Done() <-chan struct{}

type Token

+ Done func() <-chan struct{}

type UnsubscribeToken

+ func (b *UnsubscribeToken) Done() <-chan struct{}

+ type WebsocketOptions struct

+ Proxy ProxyFunction

+ ReadBufferSize int

+ WriteBufferSize int

v1.2.0

Apr 18, 2019

Changes in this version

type Client

+ IsConnectionOpen func() bool

type ClientOptions

+ HTTPHeaders http.Header

+ ResumeSubs bool

+ func (o *ClientOptions) SetHTTPHeaders(h http.Header) *ClientOptions

+ func (o *ClientOptions) SetResumeSubs(resume bool) *ClientOptions

type ClientOptionsReader

+ func (r *ClientOptionsReader) HTTPHeaders() http.Header

+ func (r *ClientOptionsReader) ResumeSubs() bool

type ConnectToken

+ func (c *ConnectToken) SessionPresent() bool

type Message

+ Ack func()

+ type TokenErrorSetter interface

v1.1.1

Mar 15, 2018

Changes in this version

type Client

+ OptionsReader func() ClientOptionsReader

type ClientOptions

+ CredentialsProvider CredentialsProvider

+ func (o *ClientOptions) SetCredentialsProvider(p CredentialsProvider) *ClientOptions

+ type CredentialsProvider func() (username string, password string)

+ type Logger interface

+ Printf func(format string, v ...interface{})

+ Println func(v ...interface{})

+ type NOOPLogger struct

+ func (NOOPLogger) Printf(format string, v ...interface{})

+ func (NOOPLogger) Println(v ...interface{})

v1.1.0

Aug 1, 2017

Changes in this version

type Client

+ AddRoute func(topic string, callback MessageHandler)

type ClientOptions

+ DefaultPublishHandler MessageHandler

+ type ClientOptionsReader struct

+ func (r *ClientOptionsReader) AutoReconnect() bool

+ func (r *ClientOptionsReader) CleanSession() bool

+ func (r *ClientOptionsReader) ClientID() string

+ func (r *ClientOptionsReader) ConnectTimeout() time.Duration

+ func (r *ClientOptionsReader) KeepAlive() time.Duration

+ func (r *ClientOptionsReader) MaxReconnectInterval() time.Duration

+ func (r *ClientOptionsReader) MessageChannelDepth() uint

+ func (r *ClientOptionsReader) Order() bool

+ func (r *ClientOptionsReader) Password() string

+ func (r *ClientOptionsReader) PingTimeout() time.Duration

+ func (r *ClientOptionsReader) ProtocolVersion() uint

+ func (r *ClientOptionsReader) Servers() []*url.URL

+ func (r *ClientOptionsReader) TLSConfig() tls.Config

+ func (r *ClientOptionsReader) Username() string

+ func (r *ClientOptionsReader) WillEnabled() bool

+ func (r *ClientOptionsReader) WillPayload() []byte

+ func (r *ClientOptionsReader) WillQos() byte

+ func (r *ClientOptionsReader) WillRetained() bool

+ func (r *ClientOptionsReader) WillTopic() string

+ func (r *ClientOptionsReader) WriteTimeout() time.Duration

+ type DummyToken struct

+ func (d *DummyToken) Error() error

+ func (d *DummyToken) Wait() bool

+ func (d *DummyToken) WaitTimeout(t time.Duration) bool

v1.0.0

Jun 9, 2016

Changes in this version

type ClientOptions

+ ConnectTimeout time.Duration

+ MessageChannelDepth uint

+ PingTimeout time.Duration

+ func (o *ClientOptions) SetConnectTimeout(t time.Duration) *ClientOptions

+ func (o *ClientOptions) SetMessageChannelDepth(s uint) *ClientOptions

+ func (o *ClientOptions) SetPingTimeout(k time.Duration) *ClientOptions

v0

v0.9.1

Mar 23, 2015

v0.9.0

Mar 23, 2015

Changes in this version

+ const CLI

+ const DEC

+ const ERR

+ const MES

+ const MID

+ const NET

+ const PNG

+ const STA

+ const STR

+ const TST

+ var CRITICAL *log.Logger

+ var DEBUG *log.Logger

+ var ERROR *log.Logger

+ var ErrInvalidQos = errors.New("Invalid QoS")

+ var ErrInvalidTopicEmptyString = errors.New("Invalid Topic; empty string")

+ var ErrInvalidTopicMultilevel = errors.New("Invalid Topic; multi-level wildcard must be last level")

+ var ErrNotConnected = errors.New("Not Connected")

+ var WARN *log.Logger

+ func DefaultConnectionLostHandler(client *Client, reason error)

+ type Client struct

+ func NewClient(o *ClientOptions) *Client

+ func (c *Client) Connect() Token

+ func (c *Client) Disconnect(quiesce uint)

+ func (c *Client) ForceDisconnect()

+ func (c *Client) IsConnected() bool

+ func (c *Client) Publish(topic string, qos byte, retained bool, payload interface{}) Token

+ func (c *Client) Subscribe(topic string, qos byte, callback MessageHandler) Token

+ func (c *Client) SubscribeMultiple(filters map[string]byte, callback MessageHandler) Token

+ func (c *Client) Unsubscribe(topics ...string) Token

+ type ClientInt interface

+ Connect func() Token

+ Disconnect func(uint)

+ ForceDisconnect func()

+ IsConnected func() bool

+ Publish func(string, byte, bool, interface{}) Token

+ Subscribe func(string, byte, MessageHandler) Token

+ SubscribeMultiple func(map[string]byte, MessageHandler) Token

+ Unsubscribe func(...string) Token

+ type ClientOptions struct

+ AutoReconnect bool

+ CleanSession bool

+ ClientID string

+ DefaultPublishHander MessageHandler

+ KeepAlive time.Duration

+ MaxReconnectInterval time.Duration

+ OnConnect OnConnectHandler

+ OnConnectionLost ConnectionLostHandler

+ Order bool

+ Password string

+ ProtocolVersion uint

+ Servers []*url.URL

+ Store Store

+ TLSConfig tls.Config

+ Username string

+ WillEnabled bool

+ WillPayload []byte

+ WillQos byte

+ WillRetained bool

+ WillTopic string

+ WriteTimeout time.Duration

+ func NewClientOptions() *ClientOptions

+ func (o *ClientOptions) AddBroker(server string) *ClientOptions

+ func (o *ClientOptions) SetAutoReconnect(a bool) *ClientOptions

+ func (o *ClientOptions) SetBinaryWill(topic string, payload []byte, qos byte, retained bool) *ClientOptions

+ func (o *ClientOptions) SetCleanSession(clean bool) *ClientOptions

+ func (o *ClientOptions) SetClientID(id string) *ClientOptions

+ func (o *ClientOptions) SetConnectionLostHandler(onLost ConnectionLostHandler) *ClientOptions

+ func (o *ClientOptions) SetDefaultPublishHandler(defaultHandler MessageHandler) *ClientOptions

+ func (o *ClientOptions) SetKeepAlive(k time.Duration) *ClientOptions

+ func (o *ClientOptions) SetMaxReconnectInterval(t time.Duration) *ClientOptions

+ func (o *ClientOptions) SetOnConnectHandler(onConn OnConnectHandler) *ClientOptions

+ func (o *ClientOptions) SetOrderMatters(order bool) *ClientOptions

+ func (o *ClientOptions) SetPassword(p string) *ClientOptions

+ func (o *ClientOptions) SetProtocolVersion(pv uint) *ClientOptions

+ func (o *ClientOptions) SetStore(s Store) *ClientOptions

+ func (o *ClientOptions) SetTLSConfig(t *tls.Config) *ClientOptions

+ func (o *ClientOptions) SetUsername(u string) *ClientOptions

+ func (o *ClientOptions) SetWill(topic string, payload string, qos byte, retained bool) *ClientOptions

+ func (o *ClientOptions) SetWriteTimeout(t time.Duration) *ClientOptions

+ func (o *ClientOptions) UnsetWill() *ClientOptions

+ type ConnectToken struct

+ func (b *ConnectToken) Error() error

+ func (b *ConnectToken) Wait() bool

+ func (b *ConnectToken) WaitTimeout(d time.Duration) bool

+ func (c *ConnectToken) ReturnCode() byte

+ type ConnectionLostHandler func(*Client, error)

+ type DisconnectToken struct

+ func (b *DisconnectToken) Error() error

+ func (b *DisconnectToken) Wait() bool

+ func (b *DisconnectToken) WaitTimeout(d time.Duration) bool

+ type FileStore struct

+ func NewFileStore(directory string) *FileStore

+ func (store *FileStore) All() []string

+ func (store *FileStore) Close()

+ func (store *FileStore) Del(key string)

+ func (store *FileStore) Get(key string) packets.ControlPacket

+ func (store *FileStore) Open()

+ func (store *FileStore) Put(key string, m packets.ControlPacket)

+ func (store *FileStore) Reset()

+ type MId uint16

+ type MemoryStore struct

+ func NewMemoryStore() *MemoryStore

+ func (store *MemoryStore) All() []string

+ func (store *MemoryStore) Close()

+ func (store *MemoryStore) Del(key string)

+ func (store *MemoryStore) Get(key string) packets.ControlPacket

+ func (store *MemoryStore) Open()

+ func (store *MemoryStore) Put(key string, message packets.ControlPacket)

+ func (store *MemoryStore) Reset()

+ type Message interface

+ Duplicate func() bool

+ MessageID func() uint16

+ Payload func() []byte

+ Qos func() byte

+ Retained func() bool

+ Topic func() string

+ type MessageHandler func(*Client, Message)

+ type OnConnectHandler func(*Client)

+ type PacketAndToken struct

+ type PublishToken struct

+ func (b *PublishToken) Error() error

+ func (b *PublishToken) Wait() bool

+ func (b *PublishToken) WaitTimeout(d time.Duration) bool

+ func (p *PublishToken) MessageID() uint16

+ type Store interface

+ All func() []string

+ Close func()

+ Del func(string)

+ Get func(string) packets.ControlPacket

+ Open func()

+ Put func(string, packets.ControlPacket)

+ Reset func()

+ type SubscribeToken struct

+ func (b *SubscribeToken) Error() error

+ func (b *SubscribeToken) Wait() bool

+ func (b *SubscribeToken) WaitTimeout(d time.Duration) bool

+ func (s *SubscribeToken) Result() map[string]byte

+ type Token interface

+ Error func() error

+ Wait func() bool

+ WaitTimeout func(time.Duration) bool

+ type UnsubscribeToken struct

+ func (b *UnsubscribeToken) Error() error

+ func (b *UnsubscribeToken) Wait() bool

+ func (b *UnsubscribeToken) WaitTimeout(d time.Duration) bool

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