mqtt

Documentation

Index

• Variables
• type Broker
  • func (b *Broker) Client(cid string) (*Client, error)
  • func (b *Broker) ClientWithOptions(opt *mqtt.ClientOptions) (*Client, error)
  • func (b *Broker) Close(c *Client)
  • func (b *Broker) CloseByCid(cid string)
  • func (b *Broker) Init() error
  • func (b *Broker) LivenessCheck() map[string]string
  • func (b *Broker) Name() string
  • func (b *Broker) SetDefault()
• type Client
  • func (c *Client) Cid() string
  • func (c *Client) Publish(payload interface{}) error
  • func (c *Client) Subscribe(handler mqtt.MessageHandler) error
  • func (c *Client) Unsubscribe() error
  • func (c *Client) WithConnTimeout(timeout time.Duration) *Client
  • func (c *Client) WithQoS(qos QOS) *Client
  • func (c *Client) WithRetain(retain bool) *Client
  • func (c *Client) WithSubTimeout(timeout time.Duration) *Client
  • func (c *Client) WithTopic(topic string) *Client
• type QOS
  • func ParseQOSFromLabel(s string) (QOS, error)
  • func ParseQOSFromString(s string) (QOS, error)
  • func (v QOS) ConstValues() []enum.IntStringerEnum
  • func (v QOS) Int() int
  • func (v QOS) Label() string
  • func (v QOS) MarshalText() ([]byte, error)
  • func (v *QOS) Scan(src interface{}) error
  • func (v QOS) String() string
  • func (v QOS) TypeName() string
  • func (v *QOS) UnmarshalText(data []byte) error
  • func (v QOS) Value() (driver.Value, error)

Variables

var InvalidQOS = errors.New("invalid QOS type")

Types

type Broker

type Broker struct {
	Server        types.Endpoint
	Retry         retry.Retry
	Timeout       types.Duration
	Keepalive     types.Duration
	RetainPublish bool
	QoS           QOS
	Cert          *conftls.X509KeyPair
	// contains filtered or unexported fields
}

func (*Broker) Client

func (b *Broker) Client(cid string) (*Client, error)

func (*Broker) ClientWithOptions

func (b *Broker) ClientWithOptions(opt *mqtt.ClientOptions) (*Client, error)

func (*Broker) Close

func (b *Broker) Close(c *Client)

func (*Broker) CloseByCid

func (b *Broker) CloseByCid(cid string)

func (*Broker) Init

func (b *Broker) Init() error

func (*Broker) LivenessCheck

func (b *Broker) LivenessCheck() map[string]string

func (*Broker) Name

func (b *Broker) Name() string

func (*Broker) SetDefault

func (b *Broker) SetDefault()

type Client

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

func (*Client) Cid

func (c *Client) Cid() string

func (*Client) Publish

func (c *Client) Publish(payload interface{}) error

func (*Client) Subscribe

func (c *Client) Subscribe(handler mqtt.MessageHandler) error

func (*Client) Unsubscribe

func (c *Client) Unsubscribe() error

func (*Client) WithConnTimeout

func (c *Client) WithConnTimeout(timeout time.Duration) *Client

func (*Client) WithQoS

func (c *Client) WithQoS(qos QOS) *Client

func (*Client) WithRetain

func (c *Client) WithRetain(retain bool) *Client

func (*Client) WithSubTimeout

func (c *Client) WithSubTimeout(timeout time.Duration) *Client

func (*Client) WithTopic

func (c *Client) WithTopic(topic string) *Client

type QOS

type QOS int8

const (
	QOS_UNKNOWN        QOS = iota - 1
	QOS__ONCE              // 0
	QOS__AT_LEAST_ONCE     // 1
	QOS__ONLY_ONCE         // 2
)

func ParseQOSFromLabel

func ParseQOSFromLabel(s string) (QOS, error)

func ParseQOSFromString

func ParseQOSFromString(s string) (QOS, error)

func (QOS) ConstValues

func (v QOS) ConstValues() []enum.IntStringerEnum

func (QOS) Int

func (v QOS) Int() int

func (QOS) Label

func (v QOS) Label() string

func (QOS) MarshalText

func (v QOS) MarshalText() ([]byte, error)

func (*QOS) Scan

func (v *QOS) Scan(src interface{}) error

func (QOS) String

func (v QOS) String() string

func (QOS) TypeName

func (v QOS) TypeName() string

func (*QOS) UnmarshalText

func (v *QOS) UnmarshalText(data []byte) error

func (QOS) Value

func (v QOS) Value() (driver.Value, error)