mqttserver

Documentation

Index

• type GizmoHook
  • func (gh *GizmoHook) ID() string
  • func (gh *GizmoHook) OnACLCheck(cl *mqtt.Client, topic string, write bool) bool
  • func (gh *GizmoHook) OnConnect(cl *mqtt.Client, pk packets.Packet) error
  • func (gh *GizmoHook) OnConnectAuthenticate(cl *mqtt.Client, pk packets.Packet) bool
  • func (gh *GizmoHook) OnDisconnect(cl *mqtt.Client, err error, expire bool)
  • func (gh *GizmoHook) OnSessionEstablished(cl *mqtt.Client, pk packets.Packet)
  • func (gh *GizmoHook) OnStarted()
  • func (gh *GizmoHook) OnSubscribed(cl *mqtt.Client, pk packets.Packet, reasonCodes []byte)
  • func (gh *GizmoHook) Provides(b byte) bool
• type Option
  • func WithLogger(l hclog.Logger) Option
  • func WithStartupWG(wg *sync.WaitGroup) Option
  • func WithStats(m *metrics.Metrics) Option
• type Server
  • func NewServer(opts ...Option) (*Server, error)
  • func (s *Server) Publish(topic string, payload []byte, retain bool, qos byte) error
  • func (s *Server) Serve(bind string) error
  • func (s *Server) Shutdown() error
  • func (s *Server) Subscribe(filter string, ID int, handler mqtt.InlineSubFn) error
• type StopHook

Types

type GizmoHook

type GizmoHook struct {
	mqtt.HookBase
	// contains filtered or unexported fields
}

GizmoHook handles all the custom logic for Gizmo

func (*GizmoHook) ID

func (gh *GizmoHook) ID() string

ID identifies this hook in the listing.

func (*GizmoHook) OnACLCheck

func (gh *GizmoHook) OnACLCheck(cl *mqtt.Client, topic string, write bool) bool

OnACLCheck gets called to work out if a client should be allowed to do things or not. The first check that we make is if the client is in either 127.0.0.0/8 (the server itself) or 100.64.0.0/24 (the FMS netblock). If either of these is true than the result is returned immediately as success. Otherwise the actual team number is checked to make sure it corresponds to the one in the topic.

func (*GizmoHook) OnConnect

func (gh *GizmoHook) OnConnect(cl *mqtt.Client, pk packets.Packet) error

OnConnect fires when a client connects, and we use this to forcibly clear all state for clients connecting to the server.

func (*GizmoHook) OnConnectAuthenticate

func (gh *GizmoHook) OnConnectAuthenticate(cl *mqtt.Client, pk packets.Packet) bool

OnConnectAuthenticate allows anyone to connect, but what they can then do is pretty heavily limited by the OnACLCheck below.

func (*GizmoHook) OnDisconnect

func (gh *GizmoHook) OnDisconnect(cl *mqtt.Client, err error, expire bool)

OnDisconnect fires when a client is disconnected for any reason.

func (*GizmoHook) OnSessionEstablished

func (gh *GizmoHook) OnSessionEstablished(cl *mqtt.Client, pk packets.Packet)

OnSessionEstablished happens after a client is completely connected and ready to send and receive data.

func (*GizmoHook) OnStarted

func (gh *GizmoHook) OnStarted()

OnStarted happens after the listeners are bound and the server is ready to process connections.

func (*GizmoHook) OnSubscribed

func (gh *GizmoHook) OnSubscribed(cl *mqtt.Client, pk packets.Packet, reasonCodes []byte)

OnSubscribed logs subscriptions as they come in for a given client. Useful for debugging and normally a noop.

func (*GizmoHook) Provides

func (gh *GizmoHook) Provides(b byte) bool

Provides flags which methods the server will invoke this hook for. Adding or removing methods in this file requires updating this value!

type Option

type Option func(*Server) error

Option enables variadic option passing to the server on startup.

func WithLogger

func WithLogger(l hclog.Logger) Option

WithLogger sets the logger for the server.

func WithStartupWG

func WithStartupWG(wg *sync.WaitGroup) Option

WithStartupWG allows a waitgroup to be passed in so the server can notify when its finished with startup tasks to allow a nice message to be printed to the console.

func WithStats

func WithStats(m *metrics.Metrics) Option

WithStats provides a registry for statistics to be retained and kept up with.

type Server

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

Server binds the server's methods

func NewServer

func NewServer(opts ...Option) (*Server, error)

NewServer returns a running mqtt broker

func (*Server) Publish

func (s *Server) Publish(topic string, payload []byte, retain bool, qos byte) error

Publish is a passthrough to the underlying server's publish function.

func (*Server) Serve

func (s *Server) Serve(bind string) error

Serve binds and serves mqtt on the bound socket. An error will be returned if the srever cannot initialize.

func (*Server) Shutdown

func (s *Server) Shutdown() error

Shutdown gracefully shuts down the server.

func (*Server) Subscribe

func (s *Server) Subscribe(filter string, ID int, handler mqtt.InlineSubFn) error

Subscribe is a passthrough to the underlying server's subscribe function.

type StopHook

type StopHook func()

StopHook is a function to be called when the MQTT server shuts down.