paho

package

Go to main page

Versions in this module

v0

v0.21.0

Feb 26, 2024

v0.20.0

Feb 3, 2024

Changes in this version

+ var ErrConnectionLost = errors.New("connection lost after request transmitted")

+ var ErrInvalidArguments = errors.New("invalid argument")

+ var ErrNetworkErrorAfterStored = errors.New("error after packet added to state")

type Client

+ func (c *Client) AddOnPublishReceived(f func(PublishReceived) (bool, error)) func()

+ func (c *Client) Done() <-chan struct{}

+ func (c *Client) PublishWithOptions(ctx context.Context, p *Publish, o PublishOptions) (*PublishResponse, error)

+ func (c *Client) TerminateConnectionForTest()

type ClientConfig

+ OnPublishReceived []func(PublishReceived) (bool, error)

+ Session session.SessionManager

+ type DefaultPinger struct

+ func NewDefaultPinger() *DefaultPinger

+ func (p *DefaultPinger) PacketSent()

+ func (p *DefaultPinger) PingResp()

+ func (p *DefaultPinger) Run(ctx context.Context, conn net.Conn, keepAlive uint16) error

+ func (p *DefaultPinger) SetDebug(debug log.Logger)

type Pinger

+ PacketSent func()

+ Run func(ctx context.Context, conn net.Conn, keepAlive uint16) error

type Publish

+ func (p *Publish) Duplicate() bool

+ type PublishMethod int

+ const PublishMethod_AsyncSend

+ const PublishMethod_Blocking

+ type PublishOptions struct

+ Method PublishMethod

+ type PublishReceived struct

+ AlreadyHandled bool

+ Client *Client

+ Errs []error

+ Packet *Publish

type StandardRouter

+ func NewStandardRouterWithDefault(h MessageHandler) *StandardRouter

+ func (r *StandardRouter) DefaultHandler(h MessageHandler)

v0.12.0

Oct 15, 2023

Changes in this version

type Connack

+ func (c *Connack) String() string

type ConnackProperties

+ func (p *ConnackProperties) String() string

type SubscribeOptions

+ Topic string

v0.11.0

Mar 12, 2023

v0.10.0

Jul 20, 2021

Changes in this version

+ var ErrManualAcknowledgmentDisabled = errors.New("manual acknowledgments disabled")

+ var ErrPacketNotFound = errors.New("packet not found")

+ var ErrorMidsExhausted = errors.New("all message ids in use")

type Client

+ func (c *Client) Ack(pb *Publish) error

+ func (c *Client) SetDebugLogger(l Logger)

+ func (c *Client) SetErrorLogger(l Logger)

+ type ClientConfig struct

+ AuthHandler Auther

+ ClientID string

+ Conn net.Conn

+ EnableManualAcknowledgment bool

+ MIDs MIDService

+ OnClientError func(error)

+ OnServerDisconnect func(*Disconnect)

+ PacketTimeout time.Duration

+ Persistence Persistence

+ PingHandler Pinger

+ PublishHook func(*Publish)

+ Router Router

+ SendAcksInterval time.Duration

type ConnackProperties

+ SessionExpiryInterval *uint32

+ type MQTTVersion byte

+ const MQTTv311

+ const MQTTv5

type PingHandler

+ func (p *PingHandler) SetDebug(l Logger)

type Pinger

+ SetDebug func(Logger)

type Publish

+ PacketID uint16

type Router

+ SetDebugLogger func(Logger)

type SingleHandlerRouter

+ func (s *SingleHandlerRouter) SetDebugLogger(l Logger)

type StandardRouter

+ func (r *StandardRouter) SetDebugLogger(l Logger)

+ type UserProperties []UserProperty

+ func UserPropertiesFromPacketUser(up []packets.User) UserProperties

+ func (u *UserProperties) Add(key, value string) *UserProperties

+ func (u UserProperties) Get(key string) string

+ func (u UserProperties) GetAll(key string) []string

+ func (u UserProperties) ToPacketProperties() []packets.User

+ type UserProperty struct

+ Key string

+ Value string

v0.9.5

Jul 20, 2021

v0.9.0

Mar 21, 2019

Changes in this version

+ func BoolToByte(b bool) *byte

+ func Byte(b byte) *byte

+ func SetDebugLogger(l Logger)

+ func SetErrorLogger(l Logger)

+ func Uint16(u uint16) *uint16

+ func Uint32(u uint32) *uint32

+ type Auth struct

+ Properties *AuthProperties

+ ReasonCode byte

+ func AuthFromPacketAuth(a *packets.Auth) *Auth

+ func (a *Auth) InitProperties(p *packets.Properties)

+ func (a *Auth) Packet() *packets.Auth

+ type AuthProperties struct

+ AuthData []byte

+ AuthMethod string

+ ReasonString string

+ User map[string]string

+ type AuthResponse struct

+ Properties *AuthProperties

+ ReasonCode byte

+ Success bool

+ func AuthResponseFromPacketAuth(a *packets.Auth) *AuthResponse

+ func AuthResponseFromPacketDisconnect(d *packets.Disconnect) *AuthResponse

+ type Auther interface

+ Authenticate func(*Auth) *Auth

+ Authenticated func()

+ type CPContext struct

+ Context context.Context

+ Return chan packets.ControlPacket

+ type Client struct

+ AuthHandler Auther

+ ClientID string

+ Conn net.Conn

+ MIDs MIDService

+ OnDisconnect func(packets.Disconnect)

+ PacketTimeout time.Duration

+ Persistence Persistence

+ PingHandler Pinger

+ Router Router

+ func NewClient() *Client

+ func (c *Client) Authenticate(ctx context.Context, a *Auth) (*AuthResponse, error)

+ func (c *Client) Connect(ctx context.Context, cp *Connect) (*Connack, error)

+ func (c *Client) Disconnect(d *Disconnect) error

+ func (c *Client) Error(e error)

+ func (c *Client) Incoming()

+ func (c *Client) Publish(ctx context.Context, p *Publish) (*PublishResponse, error)

+ func (c *Client) Subscribe(ctx context.Context, s *Subscribe) (*Suback, error)

+ func (c *Client) Unsubscribe(ctx context.Context, u *Unsubscribe) (*Unsuback, error)

+ type CommsProperties struct

+ MaximumPacketSize uint32

+ MaximumQoS byte

+ ReceiveMaximum uint16

+ RetainAvailable bool

+ SharedSubAvailable bool

+ SubIDAvailable bool

+ TopicAliasMaximum uint16

+ WildcardSubAvailable bool

+ type Connack struct

+ Properties *ConnackProperties

+ ReasonCode byte

+ SessionPresent bool

+ func ConnackFromPacketConnack(c *packets.Connack) *Connack

+ func (c *Connack) InitProperties(p *packets.Properties)

+ type ConnackProperties struct

+ AssignedClientID string

+ AuthData []byte

+ AuthMethod string

+ MaximumPacketSize *uint32

+ MaximumQoS *byte

+ ReasonString string

+ ReceiveMaximum *uint16

+ ResponseInfo string

+ RetainAvailable bool

+ ServerKeepAlive *uint16

+ ServerReference string

+ SharedSubAvailable bool

+ SubIDAvailable bool

+ TopicAliasMaximum *uint16

+ User map[string]string

+ WildcardSubAvailable bool

+ type Connect struct

+ CleanStart bool

+ ClientID string

+ KeepAlive uint16

+ Password []byte

+ PasswordFlag bool

+ Properties *ConnectProperties

+ Username string

+ UsernameFlag bool

+ WillMessage *WillMessage

+ WillProperties *WillProperties

+ func ConnectFromPacketConnect(p *packets.Connect) *Connect

+ func (c *Connect) InitProperties(p *packets.Properties)

+ func (c *Connect) InitWillProperties(p *packets.Properties)

+ func (c *Connect) Packet() *packets.Connect

+ type ConnectProperties struct

+ AuthData []byte

+ AuthMethod string

+ MaximumPacketSize *uint32

+ MaximumQOS *byte

+ ReceiveMaximum *uint16

+ RequestProblemInfo bool

+ RequestResponseInfo bool

+ SessionExpiryInterval *uint32

+ TopicAliasMaximum *uint16

+ User map[string]string

+ WillDelayInterval *uint32

+ type Disconnect struct

+ Properties *DisconnectProperties

+ ReasonCode byte

+ func DisconnectFromPacketDisconnect(p *packets.Disconnect) *Disconnect

+ func (d *Disconnect) InitProperties(p *packets.Properties)

+ func (d *Disconnect) Packet() *packets.Disconnect

+ type DisconnectProperties struct

+ ReasonString string

+ ServerReference string

+ SessionExpiryInterval *uint32

+ User map[string]string

+ type Logger interface

+ Printf func(format string, v ...interface{})

+ Println func(v ...interface{})

+ type MIDService interface

+ Clear func()

+ Free func(uint16)

+ Get func(uint16) *CPContext

+ Request func(*CPContext) uint16

+ type MIDs struct

+ func (m *MIDs) Clear()

+ func (m *MIDs) Free(i uint16)

+ func (m *MIDs) Get(i uint16) *CPContext

+ func (m *MIDs) Request(c *CPContext) uint16

+ type MemoryPersistence struct

+ func (m *MemoryPersistence) All() []packets.ControlPacket

+ func (m *MemoryPersistence) Close()

+ func (m *MemoryPersistence) Delete(id uint16)

+ func (m *MemoryPersistence) Get(id uint16) packets.ControlPacket

+ func (m *MemoryPersistence) Open()

+ func (m *MemoryPersistence) Put(id uint16, cp packets.ControlPacket)

+ func (m *MemoryPersistence) Reset()

+ type MessageHandler func(*Publish)

+ type NOOPLogger struct

+ func (NOOPLogger) Printf(format string, v ...interface{})

+ func (NOOPLogger) Println(v ...interface{})

+ type Persistence interface

+ All func() []packets.ControlPacket

+ Close func()

+ Delete func(uint16)

+ Get func(uint16) packets.ControlPacket

+ Open func()

+ Put func(uint16, packets.ControlPacket)

+ Reset func()

+ type PingFailHandler func(error)

+ type PingHandler struct

+ func DefaultPingerWithCustomFailHandler(pfh PingFailHandler) PingHandler

+ func (p *PingHandler) PingResp()

+ func (p *PingHandler) Start(c net.Conn, pt time.Duration)

+ func (p *PingHandler) Stop()

+ type Pinger interface

+ PingResp func()

+ Start func(net.Conn, time.Duration)

+ Stop func()

+ type Publish struct

+ Payload []byte

+ Properties *PublishProperties

+ QoS byte

+ Retain bool

+ Topic string

+ func PublishFromPacketPublish(p *packets.Publish) *Publish

+ func (p *Publish) InitProperties(prop *packets.Properties)

+ func (p *Publish) Packet() *packets.Publish

+ func (p *Publish) String() string

+ type PublishProperties struct

+ ContentType string

+ CorrelationData []byte

+ MessageExpiry *uint32

+ PayloadFormat *byte

+ ResponseTopic string

+ SubscriptionIdentifier *uint32

+ TopicAlias *uint16

+ User map[string]string

+ type PublishResponse struct

+ Properties *PublishResponseProperties

+ ReasonCode byte

+ func PublishResponseFromPuback(pa *packets.Puback) *PublishResponse

+ func PublishResponseFromPubcomp(pc *packets.Pubcomp) *PublishResponse

+ func PublishResponseFromPubrec(pr *packets.Pubrec) *PublishResponse

+ type PublishResponseProperties struct

+ ReasonString string

+ User map[string]string

+ type Router interface

+ RegisterHandler func(string, MessageHandler)

+ Route func(*packets.Publish)

+ UnregisterHandler func(string)

+ type SingleHandlerRouter struct

+ func NewSingleHandlerRouter(h MessageHandler) *SingleHandlerRouter

+ func (s *SingleHandlerRouter) RegisterHandler(topic string, h MessageHandler)

+ func (s *SingleHandlerRouter) Route(pb *packets.Publish)

+ func (s *SingleHandlerRouter) UnregisterHandler(topic string)

+ type StandardRouter struct

+ func NewStandardRouter() *StandardRouter

+ func (r *StandardRouter) RegisterHandler(topic string, h MessageHandler)

+ func (r *StandardRouter) Route(pb *packets.Publish)

+ func (r *StandardRouter) UnregisterHandler(topic string)

+ type Suback struct

+ Properties *SubackProperties

+ Reasons []byte

+ func SubackFromPacketSuback(s *packets.Suback) *Suback

+ func (s *Suback) Packet() *packets.Suback

+ type SubackProperties struct

+ ReasonString string

+ User map[string]string

+ type Subscribe struct

+ Properties *SubscribeProperties

+ Subscriptions map[string]SubscribeOptions

+ func (s *Subscribe) InitProperties(prop *packets.Properties)

+ func (s *Subscribe) Packet() *packets.Subscribe

+ func (s *Subscribe) PacketSubOptionsFromSubscribeOptions() map[string]packets.SubOptions

+ type SubscribeOptions struct

+ NoLocal bool

+ QoS byte

+ RetainAsPublished bool

+ RetainHandling byte

+ type SubscribeProperties struct

+ SubscriptionIdentifier *uint32

+ User map[string]string

+ type Unsuback struct

+ Properties *UnsubackProperties

+ Reasons []byte

+ func UnsubackFromPacketUnsuback(u *packets.Unsuback) *Unsuback

+ func (u *Unsuback) Packet() *packets.Unsuback

+ type UnsubackProperties struct

+ ReasonString string

+ User map[string]string

+ type Unsubscribe struct

+ Properties *UnsubscribeProperties

+ Topics []string

+ func (u *Unsubscribe) Packet() *packets.Unsubscribe

+ type UnsubscribeProperties struct

+ User map[string]string

+ type WillMessage struct

+ Payload []byte

+ QoS byte

+ Retain bool

+ Topic string

+ type WillProperties struct

+ ContentType string

+ CorrelationData []byte

+ MessageExpiry *uint32

+ PayloadFormat *byte

+ ResponseTopic string

+ User map[string]string

+ WillDelayInterval *uint32

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL