server

Documentation

Index

• func NewServer(opts ...Option) *server
• type Client
• type ClientOption
• type Deliverer
• type Option
  • func WithPersistence(persistence *config.Persistence) Option
  • func WithTcpListen(tcpListen string) Option
  • func WithWebsocketListen(websocketListen string) Option
• type Options
• type Server
• type Status

Functions

func NewServer

func NewServer(opts ...Option) *server

Types

type Client

type Client interface {
	// ClientOption return a reference of ClientOption. Do not edit.
	// This is mainly used in hooks.
	ClientOption() *ClientOption
	// Session return a reference of session information of the client. Do not edit.
	// Session info will be available after the client has passed OnSessionCreated or OnSessionResume.
	Session() *session.Session
	// Version return the protocol version of the used client.
	Version() packet.Version
	// ConnectedAt returns the connected time
	ConnectedAt() time.Time
	// Connection returns the raw net.Conn
	Connection() net.Conn
	// Close closes the client connection.
	Close() error
	// Disconnect sends a disconnect packet to client, it is use to close v5 client.
	Disconnect(disconnect *packet.Disconnect)
	Deliverer
}

Client represent a mqtt client.

type ClientOption

type ClientOption struct {
	// ClientId is the client id for the client.
	ClientId string
	// Username is the username for the client.
	Username string
	// KeepAlive is the keep alive time in seconds for the client.
	// The server will close the client if no there is no packet has been received for 1.5 times the KeepAlive time.
	KeepAlive uint16
	// SessionExpiry is the session expiry interval in seconds.
	// If the client version is v5, this value will be set into CONNACK Session Expiry Interval property.
	// See: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901082
	SessionExpiry uint32
	// MaxInflight limits the number of QoS 1 and QoS 2 publications that the client is willing to process concurrently.
	// For v3 client, it is default to config.MQTT.MaxInflight.
	// For v5 client, it is the minimum of config.MQTT.MaxInflight and Receive Maximum property in CONNECT packet.
	MaxInflight uint16
	// ReceiveMax limits the number of QoS 1 and QoS 2 publications that the server is willing to process concurrently for the Client.
	// If the client version is v5, this value will be set into Receive Maximum property in CONNACK packet.
	// See: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901083
	ReceiveMax uint16
	// ClientMaxPacketSize is the maximum packet size that the client is willing to accept.
	// The server will drop the packet if it exceeds ClientMaxPacketSize.
	// See: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901050
	ClientMaxPacketSize uint32
	// ServerMaxPacketSize is the maximum packet size that the server is willing to accept from the client.
	// See: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901086
	ServerMaxPacketSize uint32
	// ClientTopicAliasMax is highest value that the client will accept as a Topic Alias sent by the server.
	// See: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901051
	ClientTopicAliasMax uint16
	// ServerTopicAliasMax is highest value that the server will accept as a Topic Alias sent by the client.
	// See: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901088
	ServerTopicAliasMax uint16
	// RequestProblemInfo is the value to indicate whether the Reason String or User Properties should be sent in the case of failures.
	// See: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901053
	RequestProblemInfo bool
}

ClientOption is the options which controls how the server interacts with the client. It will be set after the client has connected.

type Deliverer

type Deliverer interface {
	Deliver(message message.Message) error
}

Deliverer 表示具备投递信息功能的一类对象

type Option

type Option func(server *Options)

func WithPersistence

func WithPersistence(persistence *config.Persistence) Option

func WithTcpListen

func WithTcpListen(tcpListen string) Option

func WithWebsocketListen

func WithWebsocketListen(websocketListen string) Option

type Options

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

type Server

type Server interface {
	Stop(ctx context.Context) error
	Run() error
}

type Status

type Status byte

const (
	Connecting Status = iota
	Connected
)