sgr_commhandler.driver.messaging.messaging_client_async

Provides the messaging client implementation.

Attributes

logger

Classes

`SGrMessagingClient`	Defines an abstract base class for messaging clients.
`SGrMqttClient`	Implements an MQTT messaging client.

Module Contents

sgr_commhandler.driver.messaging.messaging_client_async.logger

class sgr_commhandler.driver.messaging.messaging_client_async.SGrMessagingClient

Bases: abc.ABC

Defines an abstract base class for messaging clients.

async connect()

async disconnect()

is_connected()

Return type:: bool

async publish_async(topic, payload)

Parameters:

topic (str)
payload (Any)

async subscribe_async(topic)

Parameters:: topic (str)

async unsubscribe_async(topic)

Parameters:: topic (str)

set_message_handler(handler)

Parameters:: handler (Callable[[str, Any], NoReturn])

class sgr_commhandler.driver.messaging.messaging_client_async.SGrMqttClient(host, port, client_id, tls=False, credentials=None)

Bases: SGrMessagingClient

Implements an MQTT messaging client.

Parameters:

host (str)
port (int)
client_id (str)
tls (bool)
credentials (Optional[tuple[str, str]])

_host

_port

_tls = False

_on_message_handler: Callable[[str, Any], NoReturn] | None = None

_client

async connect()

async disconnect()

is_connected()

Return type:: bool

async publish_async(topic, payload)

Parameters:

topic (str)
payload (Any)

async subscribe_async(topic)

Parameters:: topic (str)

async unsubscribe_async(topic)

Parameters:: topic (str)

set_message_handler(handler)

Parameters:: handler (Callable[[str, Any], NoReturn])

_on_client_connect(client, flags, rc, properties)

_on_client_disconnect(client, packet)

_on_client_subscribe(client, mid, qos, properties)

_on_client_unsubscribe(client, mid, qos)

_on_client_message(client, topic, payload, qos, properties)