gemq

Documentation

Index

• Variables
• func DailWithOption(opt DialOptions) (c mqtt.Client, err error)
• func GetLogger() util.ItfLogger
• func SetGlobalMqttTopicOption(opt *MqttTopicOption)
• type AuthAPI
  • func (a *AuthAPI) ACL(c iris.Context, d *AuthRequest) (result *AuthResult, err error)
  • func (a *AuthAPI) Auth(c iris.Context, d *AuthRequest) (result *AuthResult, err error)
  • func (a *AuthAPI) Handle(r iris.Party) iris.Party
• type AuthRequest
  • func (a *AuthRequest) IsSuperuser() bool
  • func (a *AuthRequest) Reset()
• type AuthResult
• type DialOptions
• type Emq
  • func (e *Emq) Client() mqtt.Client
  • func (e *Emq) Connect(opt DialOptions)
  • func (e *Emq) Publish(topic string, payload interface{}, args ...interface{}) (err error)
  • func (e *Emq) Subscribe(topic string, callback mqtt.MessageHandler, args ...interface{}) (err error)
• type MqttFunc
• type MqttTopicOption

Variables

var (
	ErrTokenTimeout = errors.New("mqtt token timeout")
	Inc             = &Emq{}
)

var (
	API = &AuthAPI{}
)

Functions

func DailWithOption

func DailWithOption(opt DialOptions) (c mqtt.Client, err error)

func GetLogger

func GetLogger() util.ItfLogger

func SetGlobalMqttTopicOption

func SetGlobalMqttTopicOption(opt *MqttTopicOption)

Types

type AuthAPI

type AuthAPI struct {
	AuthFunc MqttFunc
	AclFunc  MqttFunc

	IsSuperFunc func(*AuthRequest) bool
}

func (*AuthAPI) ACL

func (a *AuthAPI) ACL(c iris.Context, d *AuthRequest) (result *AuthResult, err error)

ACL ...

func (*AuthAPI) Auth

func (a *AuthAPI) Auth(c iris.Context, d *AuthRequest) (result *AuthResult, err error)

Auth ...

func (*AuthAPI) Handle

func (a *AuthAPI) Handle(r iris.Party) iris.Party

Handle ...

type AuthRequest

type AuthRequest struct {
	Username   string `json:"username,omitempty"`
	Password   string `json:"password,omitempty"`
	ClientId   string `json:"clientid,omitempty"`
	PeerHost   string `json:"peerhost,omitempty"`
	ProtoName  string `json:"proto_name,omitempty"`
	MountPoint string `json:"mountpoint,omitempty"`
	Action     string `json:"action,omitempty"`
	Topic      string `json:"topic,omitempty"`
	Qos        string `json:"qos,omitempty"`
	Retain     string `json:"retain,omitempty"`
}

func (*AuthRequest) IsSuperuser

func (a *AuthRequest) IsSuperuser() bool

func (*AuthRequest) Reset

func (a *AuthRequest) Reset()

Reset Empty struct to be used in PoolAuthRequest

type AuthResult

type AuthResult struct {
	Result      string `json:"result"`
	IsSuperuser bool   `json:"is_superuser,omitempty"`
}

type DialOptions

type DialOptions struct {
	AppName string
	//tcp://host:port
	Broker   string
	Username string
	Password string
	// on connect handler
	OnConnectHandler mqtt.OnConnectHandler
}

type Emq

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

Emq ...

func (*Emq) Client

func (e *Emq) Client() mqtt.Client

Client ...

func (*Emq) Connect

func (e *Emq) Connect(opt DialOptions)

Connect ...

func (*Emq) Publish

func (e *Emq) Publish(topic string, payload interface{}, args ...interface{}) (err error)

Publish ... args can be: *MqttTopicOption, MqttTopicOption, time.Duration, bool, byte

func (*Emq) Subscribe

func (e *Emq) Subscribe(topic string, callback mqtt.MessageHandler, args ...interface{}) (err error)

Subscribe ... args can be: *MqttTopicOption, MqttTopicOption, time.Duration, bool, byte

type MqttFunc

type MqttFunc func(c iris.Context, d *AuthRequest) (result *AuthResult, err error)

type MqttTopicOption

type MqttTopicOption struct {
	Timeout time.Duration `json:"timeout,omitempty"`
	Retain  bool          `json:"retain,omitempty"`
	Qos     byte          `json:"qos,omitempty"`
}