mqtt.c File Reference

Implementation of API to handle MQTT communication. More...

#include "mqtt.h"
#include "uuidutils.h"
#include <stdlib.h>
#include <string.h>

Include dependency graph for mqtt.c:

Go to the source code of this file.

Data Structures
struct	mqtt_t

Macros
#define	G_LOG_DOMAIN   "libgvm util"
#define	QOS   1
#define	TIMEOUT   10000L

Functions
static void	mqtt_set_initialized_status (gboolean status)
	Set the global init status.
gboolean	mqtt_is_initialized ()
	Get the global init status.
static void	mqtt_set_global_server_uri (const char *server_uri_in)
	Set the global mqtt server URI.
static const char *	mqtt_get_global_server_uri ()
	Get global server URI.
static void	mqtt_set_global_username (const char *username)
	Set the global mqtt username.
static const char *	mqtt_get_global_username ()
	Get global username.
static void	mqtt_set_global_password (const char *password)
	Set the global mqtt password.
static const char *	mqtt_get_global_password ()
	Get global password.
static mqtt_t *	mqtt_get_global_client ()
static void	mqtt_set_global_client (mqtt_t *mqtt)
	Set global client.
static int	mqtt_disconnect (mqtt_t *mqtt)
	Disconnect from the Broker.
static void	mqtt_client_destroy (mqtt_t *mqtt)
	Destroy the MQTTClient client of the mqtt_t.
static void	mqtt_client_data_destroy (mqtt_t **mqtt)
	Destroy the mqtt_t data.
void	mqtt_reset ()
	Destroy MQTTClient handle and free mqtt_t.
static MQTTClient	mqtt_create (mqtt_t *mqtt, const char *address)
	Create a new mqtt client.
static char *	mqtt_set_client_id (mqtt_t *mqtt)
	Set a random client ID.
static int	mqtt_set_client (mqtt_t *mqtt, MQTTClient client)
	Set MQTTClient of mqtt_t.
static int	mqtt_connect (mqtt_t *mqtt, const char *server_uri, const char *username, const char *password)
	Make new client and connect to mqtt broker.
int	mqtt_init (const char *server_uri)
	Init MQTT communication.
int	mqtt_init_auth (const char *server_uri, const char *username, const char *password)
	Init MQTT communication.
static void	mqtt_reinit ()
	Reinitializes communication after mqtt_reset was used.
static int	mqtt_client_publish (mqtt_t *mqtt, const char *topic, const char *msg)
	Use the provided client to publish message on a topic.
int	mqtt_publish (const char *topic, const char *msg)
	Publish a message on topic using the global client.
int	mqtt_publish_single_message (const char *server_uri_in, const char *topic, const char *msg)
	Send a single message.
int	mqtt_publish_single_message_auth (const char *server_uri_in, const char *username_in, const char *passwd_in, const char *topic, const char *msg)
	Send a single message with credentials.
static int	mqtt_subscribe_r (mqtt_t *mqtt, int qos, const char *topic)
	subscribes to a single topic.
int	mqtt_subscribe (const char *topic)
	subscribes to a single topic.
static int	mqtt_unsubscribe_r (mqtt_t *mqtt, const char *topic)
	unsubscribe a single topic.
int	mqtt_unsubscribe (const char *topic)
	unsubscribe a single topic.
static int	mqtt_retrieve_message_r (mqtt_t *mqtt, char **topic, int *topic_len, char **payload, int *payload_len, const unsigned int timeout)
	wait for a given timeout in ms to retrieve any message of subscribed topics
int	mqtt_retrieve_message (char **topic, int *topic_len, char **payload, int *payload_len, const unsigned int timeout)
	wait for a given timeout in ms to retrieve any message of subscribed topics

Variables
static const char *	global_server_uri = NULL
static const char *	global_username = NULL
static const char *	global_password = NULL
static mqtt_t *	global_mqtt_client = NULL
static gboolean	mqtt_initialized = FALSE

Detailed Description

Implementation of API to handle MQTT communication.

This file contains all methods to handle MQTT communication.

Before communicating via MQTT a handle has to be created and a connection established. This is done by calling mqtt_init(). Mmessages can be published via mqtt_publish() afterwards.

mqtt_init() should be called only once at program init. After forking mqtt_reset() has to be called in the child. mqtt_publish() can be used after mqtt_reset(). No additional mqtt_init() is needed. A new connection will be established on first call to publish for the current process.

mqtt_publish_single_message() is a convenience function for sending single messages. Do not send repeated messages via this function as a new connection is established every call.

Definition in file mqtt.c.

Macro Definition Documentation

G_LOG_DOMAIN

#define G_LOG_DOMAIN   "libgvm util"

Definition at line 35 of file mqtt.c.

QOS

#define QOS   1

Definition at line 37 of file mqtt.c.

TIMEOUT

#define TIMEOUT   10000L

Definition at line 38 of file mqtt.c.

Function Documentation

mqtt_client_data_destroy()

static void mqtt_client_data_destroy ( mqtt_t **  mqtt )

static

Destroy the mqtt_t data.

Parameters

mqtt

mqtt_t

Definition at line 209 of file mqtt.c.

{
  g_free ((*mqtt)->client_id);
  g_free (*mqtt);
  *mqtt = NULL;
}

Referenced by mqtt_publish_single_message_auth(), and mqtt_reset().

Here is the caller graph for this function:

mqtt_client_destroy()

static void mqtt_client_destroy ( mqtt_t *  mqtt )

static

Destroy the MQTTClient client of the mqtt_t.

Parameters

[in]

mqtt

mqtt_t handle.

Definition at line 186 of file mqtt.c.

{
  if (mqtt == NULL)
    return;
 
  MQTTClient client;
  client = (MQTTClient) mqtt->client;
 
  if (client != NULL)
    {
      MQTTClient_destroy (&client);
      client = NULL;
    }
 
  return;
}

References mqtt_t::client.

Referenced by mqtt_publish_single_message_auth(), and mqtt_reset().

Here is the caller graph for this function:

mqtt_client_publish()

static int mqtt_client_publish ( mqtt_t *  mqtt, const char *  topic, const char *  msg  )

static

Use the provided client to publish message on a topic.

Parameters

mqtt	mqtt_t
topic	Topic to publish on.
msg	Message to publish on queue.

Returns

0 on success, <0 on failure.

Definition at line 462 of file mqtt.c.

{
  MQTTClient client;
  MQTTClient_message pubmsg = MQTTClient_message_initializer;
  MQTTClient_deliveryToken token;
  MQTTResponse resp;
  int rc;
 
  client = mqtt->client;
  if (client == NULL)
    {
      return -1;
    }
 
  pubmsg.payload = (char *) msg;
  pubmsg.payloadlen = (int) strlen (msg);
  pubmsg.qos = QOS;
  pubmsg.retained = 0;
 
  resp = MQTTClient_publishMessage5 (client, topic, &pubmsg, &token);
  rc = resp.reasonCode;
  if (rc != MQTTCLIENT_SUCCESS)
    {
      g_warning ("Failed to connect: %s", MQTTClient_strerror (rc));
      MQTTResponse_free (resp);
      return -2;
    }
 
  if ((rc = MQTTClient_waitForCompletion (client, token, TIMEOUT))
      != MQTTCLIENT_SUCCESS)
    {
      g_debug ("Message '%s' with delivery token %d could not be "
               "published on topic %s",
               msg, token, topic);
    }
 
  return rc;
}

References mqtt_t::client, QOS, and TIMEOUT.

Referenced by mqtt_publish(), and mqtt_publish_single_message_auth().

Here is the caller graph for this function:

mqtt_connect()

static int mqtt_connect ( mqtt_t *  mqtt, const char *  server_uri, const char *  username, const char *  password  )

static

Make new client and connect to mqtt broker.

Parameters

mqtt	Initialized mqtt_t
server_uri	Server URI
username	Username
password	Password

Returns

0 on success, <0 on error.

Definition at line 317 of file mqtt.c.

{
  int rc;
  MQTTClient client;
  MQTTClient_connectOptions conn_opts = MQTTClient_connectOptions_initializer5;
  MQTTProperties connect_properties = MQTTProperties_initializer;
  MQTTResponse resp;
 
  if (mqtt == NULL)
    return -1;
 
  client = mqtt_create (mqtt, server_uri);
  if (!client)
    return -2;
 
  conn_opts.keepAliveInterval = 0;
  conn_opts.cleanstart = 1;
  conn_opts.MQTTVersion = MQTTVERSION_5;
 
  if (username != NULL && password != NULL)
    {
      conn_opts.username = username;
      conn_opts.password = password;
    }
 
  resp = MQTTClient_connect5 (client, &conn_opts, &connect_properties, NULL);
  rc = resp.reasonCode;
  MQTTProperties_free (&connect_properties);
  if (rc != MQTTCLIENT_SUCCESS)
    {
      g_log (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL,
             "%s: mqtt connection error to %s: %s", __func__, server_uri,
             MQTTClient_strerror (rc));
      MQTTResponse_free (resp);
      return -3;
    }
 
  mqtt_set_client (mqtt, client);
 
  return 0;
}

References G_LOG_DOMAIN, mqtt_create(), and mqtt_set_client().

Referenced by mqtt_init_auth(), and mqtt_publish_single_message_auth().

Here is the call graph for this function:

Here is the caller graph for this function:

mqtt_create()

static MQTTClient mqtt_create ( mqtt_t *  mqtt, const char *  address  )

static

Create a new mqtt client.

Parameters

mqtt	mqtt_t
address	address of the broker

Returns

MQTTClient or NULL on error.

Definition at line 246 of file mqtt.c.

{
  MQTTClient client;
  MQTTClient_createOptions create_opts = MQTTClient_createOptions_initializer;
  create_opts.MQTTVersion = MQTTVERSION_5;
 
  if (mqtt == NULL || mqtt->client_id == NULL)
    return NULL;
 
  int rc = MQTTClient_createWithOptions (&client, address, mqtt->client_id,
                                         MQTTCLIENT_PERSISTENCE_NONE, NULL,
                                         &create_opts);
 
  if (rc != MQTTCLIENT_SUCCESS)
    {
      g_warning ("%s: Error creating MQTTClient: %s", __func__,
                 MQTTClient_strerror (rc));
      MQTTClient_destroy (&client);
      return NULL;
    }
  return client;
}

References mqtt_t::client_id.

Referenced by mqtt_connect().

Here is the caller graph for this function:

mqtt_disconnect()

static int mqtt_disconnect ( mqtt_t *  mqtt )

static

Disconnect from the Broker.

Parameters

mqtt

mqtt_t

Returns

0 on success, -1 on error.

Definition at line 164 of file mqtt.c.

{
  int rc;
 
  rc = MQTTClient_disconnect5 (mqtt->client, 200,
                               MQTTREASONCODE_NORMAL_DISCONNECTION, NULL);
  if (rc != MQTTCLIENT_SUCCESS)
    {
      g_warning ("Failed to disconnect: %s", MQTTClient_strerror (rc));
      return -1;
    }
 
  return 0;
}

References mqtt_t::client.

Referenced by mqtt_publish_single_message_auth().

Here is the caller graph for this function:

mqtt_get_global_client()

static mqtt_t * mqtt_get_global_client ( )

static

Returns

Get global client.

Definition at line 142 of file mqtt.c.

{
  return global_mqtt_client;
}

References global_mqtt_client.

Referenced by mqtt_publish(), mqtt_reset(), mqtt_retrieve_message(), mqtt_subscribe(), and mqtt_unsubscribe().

Here is the caller graph for this function:

mqtt_get_global_password()

static const char * mqtt_get_global_password ( )

static

Get global password.

Definition at line 131 of file mqtt.c.

{
  return global_password;
}

References global_password.

Referenced by mqtt_init_auth(), mqtt_publish_single_message_auth(), and mqtt_reinit().

Here is the caller graph for this function:

mqtt_get_global_server_uri()

static const char * mqtt_get_global_server_uri ( )

static

Get global server URI.

Returns

Server URI, NULL if not found.

Definition at line 91 of file mqtt.c.

{
  return global_server_uri;
}

References global_server_uri.

Referenced by mqtt_init_auth(), mqtt_publish_single_message_auth(), and mqtt_reinit().

Here is the caller graph for this function:

mqtt_get_global_username()

static const char * mqtt_get_global_username ( )

static

Get global username.

Definition at line 111 of file mqtt.c.

{
  return global_username;
}

References global_username.

Referenced by mqtt_init_auth(), mqtt_publish_single_message_auth(), and mqtt_reinit().

Here is the caller graph for this function:

mqtt_init()

int mqtt_init

(

const char *

server_uri

)

Init MQTT communication.

Parameters

server_uri

Server URI

Returns

0 on success, <0 on error.

Definition at line 368 of file mqtt.c.

{
  return mqtt_init_auth (server_uri, NULL, NULL);
}

References mqtt_init_auth().

Here is the call graph for this function:

mqtt_init_auth()

int mqtt_init_auth	(	const char *	server_uri,
		const char *	username,
		const char *	password
	)

Init MQTT communication.

Parameters

server_uri	Server URI
username	Username
password	Password

Returns

0 on success, <0 on error.

Definition at line 382 of file mqtt.c.

{
  mqtt_t *mqtt = NULL;
  const char *g_server_uri;
  const char *g_username;
  const char *g_password;
 
  g_debug ("%s: start", __func__);
 
  mqtt = g_malloc0 (sizeof (mqtt_t));
  // Set random uuid as client id
  if (mqtt_set_client_id (mqtt) == NULL)
    {
      g_warning ("%s: Could not set client id.", __func__);
      g_free (mqtt);
      mqtt = NULL;
      return -1;
    }
  g_debug ("%s: client id set: %s", __func__, mqtt->client_id);
  g_server_uri = mqtt_get_global_server_uri ();
  if (g_server_uri == NULL)
    mqtt_set_global_server_uri (server_uri);
 
  g_username = mqtt_get_global_username ();
  if (g_username == NULL)
    mqtt_set_global_username (username);
 
  g_password = mqtt_get_global_password ();
  if (g_password == NULL)
    mqtt_set_global_password (password);
 
  if (mqtt_connect (mqtt, server_uri, username, password))
    {
      g_warning ("%s: Unable to connect to MQTT broker.", __func__);
      g_free (mqtt);
      mqtt = NULL;
      return -1;
    }
 
  mqtt_set_global_client (mqtt);
  mqtt_set_initialized_status (TRUE);
 
  g_debug ("%s: end", __func__);
  return 0;
}

References mqtt_t::client_id, mqtt_connect(), mqtt_get_global_password(), mqtt_get_global_server_uri(), mqtt_get_global_username(), mqtt_set_client_id(), mqtt_set_global_client(), mqtt_set_global_password(), mqtt_set_global_server_uri(), mqtt_set_global_username(), and mqtt_set_initialized_status().

Referenced by mqtt_init(), and mqtt_reinit().

Here is the call graph for this function:

Here is the caller graph for this function:

mqtt_is_initialized()

gboolean mqtt_is_initialized

(

void

)

Get the global init status.

Returns

Initialization status of mqtt handling.

Definition at line 69 of file mqtt.c.

{
  return mqtt_initialized;
}

References mqtt_initialized.

mqtt_publish()

int mqtt_publish	(	const char *	topic,
		const char *	msg
	)

Publish a message on topic using the global client.

Parameters

topic	topic
msg	message

Returns

0 on success, <0 on error.

Definition at line 510 of file mqtt.c.

{
  mqtt_t *mqtt = NULL;
  int rc = 0;
 
  if ((mqtt_get_global_client ()) == NULL)
    mqtt_reinit ();
  mqtt = mqtt_get_global_client ();
 
  rc = mqtt_client_publish (mqtt, topic, msg);
 
  return rc;
}

References mqtt_client_publish(), mqtt_get_global_client(), and mqtt_reinit().

Here is the call graph for this function:

mqtt_publish_single_message()

int mqtt_publish_single_message	(	const char *	server_uri_in,
		const char *	topic,
		const char *	msg
	)

Send a single message.

This functions creates a mqtt handle, connects, sends the message, closes the connection and destroys the handler. This function should not be chosen for repeated and frequent messaging. Its meant for error messages and the likes emitted by openvas.

Parameters

server_uri_in	Server URI
topic	Topic to publish to
msg	Message to publish

Returns

0 on success, <0 on failure.

Definition at line 539 of file mqtt.c.

{
  return mqtt_publish_single_message_auth (server_uri_in, NULL, NULL, topic,
                                           msg);
}

References mqtt_publish_single_message_auth().

Here is the call graph for this function:

mqtt_publish_single_message_auth()

int mqtt_publish_single_message_auth	(	const char *	server_uri_in,
		const char *	username_in,
		const char *	passwd_in,
		const char *	topic,
		const char *	msg
	)

Send a single message with credentials.

This functions creates a mqtt handle, connects, sends the message, closes the connection and destroys the handler. This function should not be chosen for repeated and frequent messaging. Its meant for error messages and the likes emitted by openvas.

Parameters

server_uri_in	Server URI
username_in	Username
passwd_in	Password
topic	Topic to publish to
msg	Message to publish

Returns

0 on success, <0 on failure.

Definition at line 562 of file mqtt.c.

{
  const char *server_uri;
  const char *username = NULL;
  const char *password = NULL;
  mqtt_t *mqtt = NULL;
  int ret = 0;
 
  // If server_uri is NULL try to get global
  if (server_uri_in == NULL)
    {
      server_uri = mqtt_get_global_server_uri ();
      if (server_uri == NULL)
        {
          g_warning (
            "%s: No server URI provided and no global server URI available.",
            __func__);
          return -1;
        }
    }
  else
    {
      server_uri = server_uri_in;
    }
 
  if (username_in == NULL || passwd_in == NULL)
    {
      username = mqtt_get_global_username ();
      password = mqtt_get_global_password ();
    }
  else
    {
      username = username_in;
      password = passwd_in;
    }
 
  mqtt = g_malloc0 (sizeof (mqtt_t));
  // Set random uuid as client id
  if (mqtt_set_client_id (mqtt) == NULL)
    {
      g_warning ("%s: Could not set client id.", __func__);
      g_free (mqtt);
      return -2;
    }
 
  mqtt_connect (mqtt, server_uri, username, password);
  mqtt_client_publish (mqtt, topic, msg);
 
  mqtt_disconnect (mqtt);
  mqtt_client_destroy (mqtt);
  mqtt_client_data_destroy (&mqtt);
 
  return ret;
}

References mqtt_client_data_destroy(), mqtt_client_destroy(), mqtt_client_publish(), mqtt_connect(), mqtt_disconnect(), mqtt_get_global_password(), mqtt_get_global_server_uri(), mqtt_get_global_username(), and mqtt_set_client_id().

Referenced by mqtt_publish_single_message().

Here is the call graph for this function:

Here is the caller graph for this function:

mqtt_reinit()

static void mqtt_reinit ( )

static

Reinitializes communication after mqtt_reset was used.

Definition at line 434 of file mqtt.c.

{
  const char *server_uri;
  const char *username;
  const char *password;
 
  server_uri = mqtt_get_global_server_uri ();
  if (server_uri == NULL)
    {
      g_warning ("%s: mqtt_init() has to be called once at program start "
                 "else the server URI is not set. ",
                 __func__);
    }
  username = mqtt_get_global_username ();
  password = mqtt_get_global_password ();
  mqtt_init_auth (server_uri, username, password);
}

References mqtt_get_global_password(), mqtt_get_global_server_uri(), mqtt_get_global_username(), and mqtt_init_auth().

Referenced by mqtt_publish(), and mqtt_subscribe().

Here is the call graph for this function:

Here is the caller graph for this function:

mqtt_reset()

void mqtt_reset

(

void

)

Destroy MQTTClient handle and free mqtt_t.

Definition at line 220 of file mqtt.c.

{
  g_debug ("%s: start", __func__);
  mqtt_t *mqtt = mqtt_get_global_client ();
 
  if (mqtt == NULL)
    return;
 
  mqtt_client_destroy (mqtt);
  mqtt_client_data_destroy (&mqtt);
 
  mqtt_set_global_client (NULL);
 
  g_debug ("%s: end", __func__);
  return;
}

References mqtt_client_data_destroy(), mqtt_client_destroy(), mqtt_get_global_client(), and mqtt_set_global_client().

Here is the call graph for this function:

mqtt_retrieve_message()

int mqtt_retrieve_message	(	char **	topic,
		int *	topic_len,
		char **	payload,
		int *	payload_len,
		const unsigned int	timeout
	)

wait for a given timeout in ms to retrieve any message of subscribed topics

This function performs a synchronous receive of incoming messages. Using this function allows a single-threaded client subscriber application to be written. When called, this function blocks until the next message arrives or the specified timeout expires.

Important note: The application must free() the memory allocated to the topic and payload when processing is complete.

Parameters

[out]	topic	The address of a pointer to a topic. This function allocates the memory for the topic and returns it to the application by setting topic to point to the topic.
[out]	topic_len	The length of the topic.
[out]	payload	The address of a pointer to the received message. This function allocates the memory for the payload and returns it to the application by setting payload to point to the received message. The pointer is set to NULL if the timeout expires.
[out]	payload_len	The length of the payload.
	timeout	The length of time to wait for a message in milliseconds.

Returns

0 on message retrieved, 1 on timeout and -1 on an error.

Definition at line 838 of file mqtt.c.

{
  return mqtt_retrieve_message_r (mqtt_get_global_client (), topic, topic_len,
                                  payload, payload_len, timeout);
}

References mqtt_get_global_client(), and mqtt_retrieve_message_r().

Here is the call graph for this function:

mqtt_retrieve_message_r()

static int mqtt_retrieve_message_r ( mqtt_t *  mqtt, char **  topic, int *  topic_len, char **  payload, int *  payload_len, const unsigned int  timeout  )

static

wait for a given timeout in ms to retrieve any message of subscribed topics

This function performs a synchronous receive of incoming messages. Using this function allows a single-threaded client subscriber application to be written. When called, this function blocks until the next message arrives or the specified timeout expires.

Important note: The application must free() the memory allocated to the topic and payload when processing is complete.

Parameters

	mqtt	an already created and connected mqtt client.
[out]	topic	The address of a pointer to a topic. This function allocates the memory for the topic and returns it to the application by setting topic to point to the topic.
[out]	topic_len	The length of the topic.
[out]	payload	The address of a pointer to the received message. This function allocates the memory for the payload and returns it to the application by setting payload to point to the received message. The pointer is set to NULL if the timeout expires.
[out]	payload_len	The length of the payload.
	timeout	The length of time to wait for a message in milliseconds.

Returns

0 on message retrieved, 1 on no message retrieved and -1 on an error.

Definition at line 745 of file mqtt.c.

{
  int rc = -1;
  char *tmp = NULL;
  MQTTClient_message *message = NULL;
  if (mqtt == NULL || mqtt->client == NULL)
    {
      g_warning ("mqtt is not initialized.");
      goto exit;
    }
  // copy from tmp into topic to make free work as usual and don't force the
  // user to double check topic_len and topic
  rc = MQTTClient_receive (mqtt->client, &tmp, topic_len, &message, timeout);
  if (rc == MQTTCLIENT_SUCCESS || rc == MQTTCLIENT_TOPICNAME_TRUNCATED)
    {
      if (message)
        {
          g_debug ("%s: got message %s (%d) on topic %s (%d) \n", __func__,
                   (char *) message->payload, message->payloadlen, tmp,
                   *topic_len);
 
          if ((*topic = calloc (1, *topic_len)) == NULL)
            {
              goto exit;
            }
          rc = 0;
          if ((memcpy (*topic, tmp, *topic_len)) == NULL)
            {
              g_warning ("unable to copy topic");
              rc = -1;
              goto exit;
            }
 
          *payload_len = message->payloadlen;
          *payload = calloc (1, message->payloadlen);
          if ((memcpy (*payload, (char *) message->payload,
                       message->payloadlen))
              == NULL)
            {
              g_warning ("unable to copy payload");
              rc = -1;
              goto exit;
            }
        }
      else
        {
          rc = 1;
          *payload = NULL;
          *payload_len = 0;
          *topic = NULL;
          *topic_len = 0;
        }
    }
  else
    {
      rc = -1;
    }
 
exit:
  if (message != NULL)
    MQTTClient_freeMessage (&message);
  if (tmp != NULL)
    MQTTClient_free (tmp);
 
  return rc;
}

References mqtt_t::client.

Referenced by mqtt_retrieve_message().

Here is the caller graph for this function:

mqtt_set_client()

static int mqtt_set_client ( mqtt_t *  mqtt, MQTTClient  client  )

static

Set MQTTClient of mqtt_t.

Returns

0 on success, -1 on failure.

Definition at line 296 of file mqtt.c.

{
  if (mqtt == NULL)
    {
      return -1;
    }
  mqtt->client = client;
  return 0;
}

References mqtt_t::client.

Referenced by mqtt_connect().

Here is the caller graph for this function:

mqtt_set_client_id()

static char * mqtt_set_client_id ( mqtt_t *  mqtt )

static

Set a random client ID.

Parameters

mqtt

mqtt_t

Returns

Client ID which was set, NULL on failure.

Definition at line 277 of file mqtt.c.

{
  if (mqtt == NULL)
    return NULL;
 
  char *uuid;
 
  uuid = gvm_uuid_make ();
  mqtt->client_id = uuid;
 
  return uuid;
}

References mqtt_t::client_id, and gvm_uuid_make().

Referenced by mqtt_init_auth(), and mqtt_publish_single_message_auth().

Here is the call graph for this function:

Here is the caller graph for this function:

mqtt_set_global_client()

static void mqtt_set_global_client ( mqtt_t *  mqtt )

static

Set global client.

Definition at line 151 of file mqtt.c.

{
  global_mqtt_client = mqtt;
}

References global_mqtt_client.

Referenced by mqtt_init_auth(), and mqtt_reset().

Here is the caller graph for this function:

mqtt_set_global_password()

static void mqtt_set_global_password ( const char *  password )

static

Set the global mqtt password.

Parameters

password

to set.

Definition at line 122 of file mqtt.c.

{
  global_password = password;
}

References global_password.

Referenced by mqtt_init_auth().

Here is the caller graph for this function:

mqtt_set_global_server_uri()

static void mqtt_set_global_server_uri ( const char *  server_uri_in )

static

Set the global mqtt server URI.

Parameters

server_uri_in

Server uri to set.

Definition at line 80 of file mqtt.c.

{
  global_server_uri = server_uri_in;
}

References global_server_uri.

Referenced by mqtt_init_auth().

Here is the caller graph for this function:

mqtt_set_global_username()

static void mqtt_set_global_username ( const char *  username )

static

Set the global mqtt username.

Parameters

username

to set.

Definition at line 102 of file mqtt.c.

{
  global_username = username;
}

References global_username.

Referenced by mqtt_init_auth().

Here is the caller graph for this function:

mqtt_set_initialized_status()

static void mqtt_set_initialized_status ( gboolean  status )

static

Set the global init status.

Parameters

status

Status of initialization.

Definition at line 58 of file mqtt.c.

{
  mqtt_initialized = status;
}

References mqtt_initialized.

Referenced by mqtt_init_auth().

Here is the caller graph for this function:

mqtt_subscribe()

int mqtt_subscribe

(

const char *

topic

)

subscribes to a single topic.

mqtt_subscribe uses global mqtt_t to subscribe with global qos to given topic.

To be able to subscribe to a topic the client needs to be connected to a broker. To do that call mqtt_init before mqtt_subscribe.

Parameters

topic

Topic to subscribe to

Returns

0 on success, -1 when mqtt is not initialized, -2 when subscription failed.

Definition at line 670 of file mqtt.c.

{
  if ((mqtt_get_global_client ()) == NULL)
    mqtt_reinit ();
  return mqtt_subscribe_r (mqtt_get_global_client (), QOS, topic);
}

References mqtt_get_global_client(), mqtt_reinit(), mqtt_subscribe_r(), and QOS.

Here is the call graph for this function:

mqtt_subscribe_r()

static int mqtt_subscribe_r ( mqtt_t *  mqtt, int  qos, const char *  topic  )

static

subscribes to a single topic.

mqtt_subscribe_r uses given mqtt_t to subscribe with given qos to given topic.

To be able to subscribe to a topic the client needs to be connected to a broker.

Parameters

mqtt	contains the mqtt client
qos	quality of service of messages within topic
topic	Topic to subscribe to

Returns

0 on success, -1 when given mqtt is not useable, -2 when subscription failed.

Definition at line 637 of file mqtt.c.

{
  if (mqtt == NULL || mqtt->client == NULL)
    {
      return -1;
    }
  MQTTSubscribe_options opts = MQTTSubscribe_options_initializer;
  MQTTProperties props = MQTTProperties_initializer;
  MQTTResponse resp =
    MQTTClient_subscribe5 (mqtt->client, topic, qos, &opts, &props);
  if (resp.reasonCode != MQTTREASONCODE_GRANTED_QOS_1)
    {
      return -2;
    }
  return 0;
}

References mqtt_t::client.

Referenced by mqtt_subscribe().

Here is the caller graph for this function:

mqtt_unsubscribe()

int mqtt_unsubscribe

(

const char *

topic

)

unsubscribe a single topic.

This function unsubscribes global client from a given topic.

Parameters

topic

Topic to unsubscribe from

Returns

0 on success, -1 when given mqtt is not useable, -2 when unsubscribe failed.

Definition at line 715 of file mqtt.c.

{
  return mqtt_unsubscribe_r (mqtt_get_global_client (), topic);
}

References mqtt_get_global_client(), and mqtt_unsubscribe_r().

Here is the call graph for this function:

mqtt_unsubscribe_r()

static int mqtt_unsubscribe_r ( mqtt_t *  mqtt, const char *  topic  )

static

unsubscribe a single topic.

This function unsubscribes given client from a given topic.

Parameters

mqtt	contains the mqtt client
topic	Topic to unsubscribe from

Returns

0 on success, -1 when given mqtt is not useable, -2 when unsubscribe failed.

Definition at line 689 of file mqtt.c.

{
  if (mqtt == NULL || mqtt->client == NULL)
    {
      return -1;
    }
 
  if (MQTTClient_unsubscribe (mqtt->client, topic) != MQTTCLIENT_SUCCESS)
    {
      return -2;
    }
 
  return 0;
}

References mqtt_t::client.

Referenced by mqtt_unsubscribe().

Here is the caller graph for this function:

Variable Documentation

global_mqtt_client

mqtt_t* global_mqtt_client = NULL

static

Definition at line 49 of file mqtt.c.

Referenced by mqtt_get_global_client(), and mqtt_set_global_client().

global_password

const char* global_password = NULL

static

Definition at line 48 of file mqtt.c.

Referenced by mqtt_get_global_password(), and mqtt_set_global_password().

global_server_uri

const char* global_server_uri = NULL

static

Definition at line 46 of file mqtt.c.

Referenced by mqtt_get_global_server_uri(), and mqtt_set_global_server_uri().

global_username

const char* global_username = NULL

static

Definition at line 47 of file mqtt.c.

Referenced by mqtt_get_global_username(), and mqtt_set_global_username().

mqtt_initialized

gboolean mqtt_initialized = FALSE

static

Definition at line 50 of file mqtt.c.

Referenced by mqtt_is_initialized(), and mqtt_set_initialized_status().