Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

mqttspec

package

Go to main page

Versions in this module

v1

v1.0.4

Dec 31, 2025

v1.0.3

Dec 30, 2025

v1.0.2

Dec 30, 2025

v1.0.1

Dec 30, 2025

v1.0.0

Dec 30, 2025

v0

v0.0.122

Dec 30, 2025

Changes in this version

+ const AfterConnect

+ const AfterCreate

+ const AfterDelete

+ const AfterDisconnect

+ const AfterRead

+ const AfterSubscribe

+ const AfterUnsubscribe

+ const AfterUpdate

+ const BeforeConnect

+ const BeforeCreate

+ const BeforeDelete

+ const BeforeDisconnect

+ const BeforeRead

+ const BeforeSubscribe

+ const BeforeUnsubscribe

+ const BeforeUpdate

+ const MessageTypeError

+ const MessageTypeNotification

+ const MessageTypePing

+ const MessageTypePong

+ const MessageTypeRequest

+ const MessageTypeResponse

+ const MessageTypeSubscription

+ const OperationCreate

+ const OperationDelete

+ const OperationMeta

+ const OperationRead

+ const OperationSubscribe

+ const OperationUnsubscribe

+ const OperationUpdate

+ var NewErrorResponse = websocketspec.NewErrorResponse

+ var NewNotificationMessage = websocketspec.NewNotificationMessage

+ var NewResponseMessage = websocketspec.NewResponseMessage

+ var ParseMessage = websocketspec.ParseMessage

+ type AuthConfig struct

+ ValidateCredentials func(username, password string) bool

+ type BrokerConfig struct

+ EnableAuth bool

+ EnableWebSocket bool

+ Host string

+ KeepAlive time.Duration

+ MaxConnections int

+ Port int

+ WSPort int

+ type BrokerInterface interface

+ GetClientManager func() *ClientManager

+ IsConnected func() bool

+ Publish func(topic string, qos byte, payload []byte) error

+ SetHandler func(handler *Handler)

+ Start func(ctx context.Context) error

+ Stop func(ctx context.Context) error

+ Subscribe func(topicFilter string, qos byte, callback MessageCallback) error

+ Unsubscribe func(topicFilter string) error

+ type BrokerMode string

+ const BrokerModeEmbedded

+ const BrokerModeExternal

+ type Client struct

+ ConnectedAt time.Time

+ ID string

+ Username string

+ func NewClient(id, username string, handler *Handler) *Client

+ func (c *Client) AddSubscription(sub *Subscription)

+ func (c *Client) Close()

+ func (c *Client) GetMetadata(key string) (interface{}, bool)

+ func (c *Client) GetSubscription(subID string) (*Subscription, bool)

+ func (c *Client) RemoveSubscription(subID string)

+ func (c *Client) SetMetadata(key string, value interface{})

+ type ClientManager struct

+ func NewClientManager(ctx context.Context) *ClientManager

+ func (cm *ClientManager) Count() int

+ func (cm *ClientManager) GetClient(clientID string) (*Client, bool)

+ func (cm *ClientManager) Register(clientID, username string, handler *Handler) *Client

+ func (cm *ClientManager) Shutdown()

+ func (cm *ClientManager) Unregister(clientID string)

+ type Config struct

+ Auth AuthConfig

+ Broker BrokerConfig

+ BrokerMode BrokerMode

+ ExternalBroker ExternalBrokerConfig

+ QoS QoSConfig

+ Timeouts TimeoutConfig

+ Topics TopicConfig

+ func DefaultConfig() *Config

+ type EmbeddedBroker struct

+ func NewEmbeddedBroker(config BrokerConfig, clientManager *ClientManager) *EmbeddedBroker

+ func (eb *EmbeddedBroker) GetClientManager() *ClientManager

+ func (eb *EmbeddedBroker) IsConnected() bool

+ func (eb *EmbeddedBroker) Publish(topic string, qos byte, payload []byte) error

+ func (eb *EmbeddedBroker) SetHandler(handler *Handler)

+ func (eb *EmbeddedBroker) Start(ctx context.Context) error

+ func (eb *EmbeddedBroker) Stop(ctx context.Context) error

+ func (eb *EmbeddedBroker) Subscribe(topicFilter string, qos byte, callback MessageCallback) error

+ func (eb *EmbeddedBroker) Unsubscribe(topicFilter string) error

+ type ErrorInfo = websocketspec.ErrorInfo

+ type ExternalBrokerClient struct

+ func NewExternalBrokerClient(config ExternalBrokerConfig, clientManager *ClientManager) *ExternalBrokerClient

+ func (ebc *ExternalBrokerClient) GetClientManager() *ClientManager

+ func (ebc *ExternalBrokerClient) IsConnected() bool

+ func (ebc *ExternalBrokerClient) Publish(topic string, qos byte, payload []byte) error

+ func (ebc *ExternalBrokerClient) SetHandler(handler *Handler)

+ func (ebc *ExternalBrokerClient) Start(ctx context.Context) error

+ func (ebc *ExternalBrokerClient) Stop(ctx context.Context) error

+ func (ebc *ExternalBrokerClient) Subscribe(topicFilter string, qos byte, callback MessageCallback) error

+ func (ebc *ExternalBrokerClient) Unsubscribe(topicFilter string) error

+ type ExternalBrokerConfig struct

+ BrokerURL string

+ CleanSession bool

+ ClientID string

+ ConnectTimeout time.Duration

+ KeepAlive time.Duration

+ MaxReconnect int

+ Password string

+ ReconnectDelay time.Duration

+ TLSConfig *tls.Config

+ Username string

+ type Handler struct

+ func NewHandler(db common.Database, registry common.ModelRegistry, config *Config) (*Handler, error)

+ func NewHandlerWithBun(db *bun.DB, opts ...Option) (*Handler, error)

+ func NewHandlerWithDatabase(db common.Database, registry common.ModelRegistry, opts ...Option) (*Handler, error)

+ func NewHandlerWithGORM(db *gorm.DB, opts ...Option) (*Handler, error)

+ func (h *Handler) GetDatabase() common.Database

+ func (h *Handler) GetRelationshipInfo(modelType reflect.Type, relationName string) *common.RelationshipInfo

+ func (h *Handler) Hooks() *HookRegistry

+ func (h *Handler) Registry() common.ModelRegistry

+ func (h *Handler) Shutdown() error

+ func (h *Handler) Start() error

+ type HookContext = websocketspec.HookContext

+ type HookFunc = websocketspec.HookFunc

+ type HookRegistry = websocketspec.HookRegistry

+ func NewHookRegistry() *HookRegistry

+ type HookType = websocketspec.HookType

+ type Message = websocketspec.Message

+ type MessageCallback func(topic string, payload []byte)

+ type MessageType = websocketspec.MessageType

+ type NotificationMessage = websocketspec.NotificationMessage

+ type OperationType = websocketspec.OperationType

+ type Option func(*Handler) error

+ func WithEmbeddedBroker(config BrokerConfig) Option

+ func WithExternalBroker(config ExternalBrokerConfig) Option

+ func WithHooks(hooks *HookRegistry) Option

+ func WithQoS(request, response, notification byte) Option

+ func WithTopicPrefix(prefix string) Option

+ type QoSConfig struct

+ Notification byte

+ Request byte

+ Response byte

+ type ResponseMessage = websocketspec.ResponseMessage

+ type Subscription = websocketspec.Subscription

+ type SubscriptionManager = websocketspec.SubscriptionManager

+ func NewSubscriptionManager() *SubscriptionManager

+ type TimeoutConfig struct

+ Connect time.Duration

+ Disconnect time.Duration

+ Publish time.Duration

+ type TopicConfig struct

+ Prefix string