Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

mqtt

package module

Go to main page

Versions in this module

v1

v1.0.5

Nov 8, 2023

v1.0.4

Apr 11, 2023

Changes in this version

type ClientOption

+ func WithConnectBackoffMaxInterval(maxInterval time.Duration) ClientOption

v1.0.3

Apr 11, 2023

Changes in this version

type Client

+ Status func() ConnectionStatus

v1.0.2

Apr 11, 2023

v1.0.1

Apr 10, 2023

v1.0.0

Apr 10, 2023

Changes in this version

+ const SubackFailure

+ const SubackSuccessQoS0

+ const SubackSuccessQoS1

+ const SubackSuccessQoS2

+ var ErrAlreadyRunning = errors.New("client is already running")

+ var ErrConnectionClosedForReconnect = errors.New("connection closed for reconnect")

+ var ErrConnectionStopped = errors.New("connection stopped")

+ var ErrEmptyBroker = errors.New("broker must be provided")

+ var ErrEmptyHost = errors.New("empty host")

+ var ErrFlushWithNilError = errors.New("signaler must be closed with a non-nil error")

+ var ErrNoRequestForResponse = errors.New("no request for response")

+ var ErrNoSubscription = errors.New("no subscription matches packet topic name")

+ var ErrNotConnack = errors.New("not connack packet")

+ var ErrRequestReplaced = errors.New("replaced by new request")

+ var ErrSubackReturnedFailureCode = errors.New("suback returned failure")

+ var ErrSubscriptionAlreadyRegistered = errors.New("subscription already registered")

+ var ErrUnsupportedPacketType = errors.New("unsupported packet type")

+ var ErrUnsupportedScheme = errors.New("unsupported broker scheme")

+ type Client interface

+ Publish func(ctx context.Context, topic string, payload []byte, qos QosLevel) Future[packets.ControlPacket]

+ Reconnect func()

+ ReconnectWithCredentials func(username string, password string)

+ Run func(ctx context.Context) error

+ Subscribe func(ctx context.Context, topic string, qos QosLevel, handler OnReceiveHandler) Future[packets.SubackPacket]

+ Unsubscribe func(ctx context.Context, topic string) Future[packets.UnsubackPacket]

+ func NewClient(broker string, opts ...ClientOption) (Client, error)

+ type ClientOption func(*client)

+ func WithCleanSession(clean bool) ClientOption

+ func WithClientId(clientId string) ClientOption

+ func WithConnectTimeout(timeout time.Duration) ClientOption

+ func WithConnectionFactory(factory Factory) ClientOption

+ func WithDisconnectTimeout(timeout time.Duration) ClientOption

+ func WithKeepAliveInterval(interval time.Duration) ClientOption

+ func WithKeepAliveTimeout(timeout time.Duration) ClientOption

+ func WithLogger(logger *slog.Logger) ClientOption

+ func WithOnConnectionStatusHandler(handler OnConnectionStatusHandler) ClientOption

+ func WithPassword(password string) ClientOption

+ func WithUsername(username string) ClientOption

+ type ConnectionStatus struct

+ Code ConnectionStatusCode

+ Err error

+ type ConnectionStatusCode = int

+ const Connected

+ const Connecting

+ const Disconnected

+ const Stopped

+ type Factory interface

+ Create func(broker string) (net.Conn, error)

+ func NewFactory(dialer *net.Dialer, tlsConfig *tls.Config) Factory

+ type Future interface

+ Complete func(value T, err error) Future[T]

+ Done func() <-chan any

+ Error func() error

+ Value func() T

+ func NewFuture() Future[T]

+ type OnConnectionStatusHandler func(client Client, status ConnectionStatus)

+ type OnReceiveHandler func(client Client, packet packets.PublishPacket) error

+ type QosLevel = byte

+ const QosLevel0

+ const QosLevel1

+ type Result interface

+ Error func() error

+ Value func() T

+ func NewResult(value T, err error) Result[T]