mqtt.h File Reference

Protos for MQTT handling. More...

#include <MQTTClient.h>
#include <glib.h>

Include dependency graph for mqtt.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	AUTH_MQTT   1

Functions
int	mqtt_init (const char *)
	Init MQTT communication.
int	mqtt_init_auth (const char *, const char *, const char *)
	Init MQTT communication.
gboolean	mqtt_is_initialized (void)
	Get the global init status.
void	mqtt_reset (void)
	Destroy MQTTClient handle and free mqtt_t.
int	mqtt_publish (const char *, const char *)
	Publish a message on topic using the global client.
int	mqtt_publish_single_message_auth (const char *, const char *, const char *, const char *, const char *)
	Send a single message with credentials.
int	mqtt_publish_single_message (const char *, const char *, const char *)
	Send a single message.
int	mqtt_subscribe (const char *)
	subscribes to a single topic.
int	mqtt_retrieve_message (char **, int *, char **, int *, const unsigned int)
	wait for a given timeout in ms to retrieve any message of subscribed topics
int	mqtt_unsubscribe (const char *)
	unsubscribe a single topic.

Detailed Description

Protos for MQTT handling.

Definition in file mqtt.h.

Macro Definition Documentation

AUTH_MQTT

#define AUTH_MQTT   1

Definition at line 17 of file mqtt.h.

Function Documentation

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 361 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 375 of file mqtt.c.

{
  mqtt_t *mqtt = NULL;
 
  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);
  if (mqtt_get_global_server_uri () == NULL)
    mqtt_set_global_server_uri (server_uri);
 
  if (mqtt_get_global_username () == NULL)
    mqtt_set_global_username (username);
 
  if (mqtt_get_global_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 498 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 527 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 550 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_reset()

void mqtt_reset

(

void

)

Destroy MQTTClient handle and free mqtt_t.

Definition at line 212 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 837 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_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 660 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_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 705 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: