package
0.22.0
Repository: https://github.com/eclipse/paho.golang.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

AuthFromPacketAuth takes a packets library Auth and returns a paho library Auth.
AuthResponseFromPacketAuth takes a packets library Auth and returns a paho library AuthResponse.
AuthResponseFromPacketDisconnect takes a packets library Disconnect and returns a paho library AuthResponse.
BoolToByte is a helper function that take a bool and returns a pointer to a byte of value 1 if true or 0 if false.
Byte is a helper function that take a byte and returns a pointer to a byte of that value.
ConnackFromPacketConnack takes a packets library Connack and returns a paho library Connack.
ConnectFromPacketConnect takes a packets library Connect and returns a paho library Connect.
DisconnectFromPacketDisconnect takes a packets library Disconnect and returns a paho library Disconnect.
NewClient is used to create a new default instance of an MQTT client.
NewDefaultPinger creates a DefaultPinger.
NewSingleHandlerRouter instantiates a router that will call the passed in message handler for all inbound messages (assuming `RegisterHandler` is never called).
NewStandardRouter instantiates and returns an instance of a StandardRouter.
NewStandardRouterWithDefault instantiates and returns an instance of a StandardRouter with the default handler set to the value passed in (for convenience when creating handler inline).
PublishFromPacketPublish takes a packets library Publish and returns a paho library Publish.
PublishResponseFromPuback takes a packets library Puback and returns a paho library PublishResponse.
PublishResponseFromPubcomp takes a packets library Pubcomp and returns a paho library PublishResponse.
PublishResponseFromPubrec takes a packets library Pubrec and returns a paho library PublishResponse.
SubackFromPacketSuback takes a packets library Suback and returns a paho library Suback.
Uint16 is a helper function that take a uint16 and returns a pointer to a uint16 of that value.
Uint32 is a helper function that take a uint32 and returns a pointer to a uint32 of that value.
UnsubackFromPacketUnsuback takes a packets library Unsuback and returns a paho library Unsuback.
UserPropertiesFromPacketUser converts a slice of packets.User to an instance of UserProperties for easier consumption within the client library.

# Constants

No description provided by the author
No description provided by the author
PublishWithOptions will add the message to the session and then return (no method to check status is provided).
by default PublishWithOptions will block until the publish transaction is complete.

# Variables

We don't know whether the server received the request or not.
If included (errors.Join) in an error, there is a problem with the arguments passed.
No description provided by the author
Could not send packet but its stored (and response will be sent on chan at some point in the future).
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
AuthResponse is a represenation of the response to an Auth packet.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DefaultPinger is the default implementation of Pinger.
No description provided by the author
No description provided by the author
No description provided by the author
PublishOptions enables the behaviour of Publish to be modified.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
StandardRouter is a library provided implementation of a Router that allows for unique and multiple MessageHandlers per topic.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SubscribeProperties is a struct of the properties that can be set for a Subscribe packet.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
UserProperty is a struct for the user provided values permitted in the properties section.
No description provided by the author
No description provided by the author

# Interfaces

Auther is the interface for something that implements the extended authentication flows in MQTT v5.
No description provided by the author
Router is an interface of the functions for a struct that is used to handle invoking MessageHandlers depending on the the topic the message was published on.

# Type aliases

MessageHandler is a type for a function that is invoked by a Router when it has received a Publish.
No description provided by the author
No description provided by the author
UserProperties is a slice of UserProperty.