connection_internal
[Internal functions of Easydbus Library]

Collaboration diagram for connection_internal:

---

Detailed Description

Module with internal functions for manage connection to DBus bus.

Connection Meta Information

Contact:

Daniele Rondina aka Ge@@ru <geaaru@gmail.com>

Status:

EasyDbus Core Library

License:

GPL

Contributor(s):

• Daniele Rondina aka Ge@@ru <geaaru@gmail.com>

Functions
void	close_dbus_connection (EasyDbus_conn *data)
	Close DBus connection.
int	easydbus_acquire_name (struct EasyDbus_core *core, char *serviceName, int flags, DBusError *err)
	Acquire service name.
int	easydbus_connect_to_bus (struct EasyDbus_core *core, DBusError *err, DBusBusType type_bus)
	Connect to dbus bus.
char *	easydbus_found_new_name (struct EasyDbus_core *core, char *oldName, int flags, DBusError *err)
	Found a new service name.
int	easydbus_get_address_onsession (struct EasyDbus_conn *data, char *serviceName)
	Acquire source address on session bus.
int	easydbus_get_address_onsystem (struct EasyDbus_conn *data, char *serviceName)
	Acquire source address for system dbus bus.
int	easydbus_get_address_serverSession (struct EasyDbus_conn *data, char *serviceName)
	Acquire source addres for server on session bus.
int	easydbus_set_request_flags (int easydbus_flags)
	Convert easydbus_connection_flags to dbus_flags.
int	easydbus_set_unique_nameID (struct EasyDbus_core *core, char *nameId)
	Set unique name ID.

---

Function Documentation

void close_dbus_connection

(

EasyDbus_conn *

data

)

Close DBus connection.

Note:

Only for non shared connections

Todo:

verify this function.

For internal use only.

Parameters:

data

EasyDbus_conn object pointer

Definition at line 340 of file acquire_internal.c.

References EasyDbus_core::conn.

{
   struct EasyDbus_core *core = (struct EasyDbus_core *) data;

   dbus_connection_close (core->conn);
}

int easydbus_acquire_name	(	struct EasyDbus_core *	core,
		char *	serviceName,
		int	flags,
		DBusError *	err
	)			[inline]

Acquire service name.

For internal use only.

Parameters:

	core	pointer to EasyDbus_core object
	serviceName	name used for acquire service name
	flags	easydbus flags for connection
	err	pointer to DBusError object.

Returns:

-1 on error

EASYDBUS_CONN_NAME_SERVICE_EXISTS name service exists.

EASYDBUS_CONN_NAME_SERVICE_IN_QUEUE name service in queue.

EASYDBUS_CONN_NAME_SERVICE_PRIMARY name service is primary name.

Todo:

rename this function

Definition at line 90 of file acquire_name.c.

References EasyDbus_core::conn, EASYDBUS_CONN_NAME_SERVICE_EXISTS, EASYDBUS_CONN_NAME_SERVICE_IN_QUEUE, EASYDBUS_CONN_NAME_SERVICE_PRIMARY, easydbus_set_request_flags(), and EasyDbusDebug.

Referenced by easydbus_conn_reconnect(), easydbus_found_new_name(), easydbus_get_address_onsession(), easydbus_get_address_onsystem(), and easydbus_get_address_serverSession().

{
   int result = -1;
   int dbus_flags = 0;

   EasyDbusDebug ("Request name");

   dbus_flags = easydbus_set_request_flags (flags);

   /* TODO: manage return values correctly */
   /* request for set service name */
   result = dbus_bus_request_name
      (core->conn, serviceName, dbus_flags, err);

   if (dbus_error_is_set (err)) {
      EasyDbusDebug ("Error %s from "
                     "dbus_bus_request_name: %s",
                     err->name, err->message);
      return -1;
   }

   switch (result) {
      case DBUS_REQUEST_NAME_REPLY_EXISTS:
         EasyDbusDebug ("Owner already exist");
         result = EASYDBUS_CONN_NAME_SERVICE_EXISTS;
         break;
      case DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER:
         EasyDbusDebug ("Service is primary onwner");
         result = EASYDBUS_CONN_NAME_SERVICE_PRIMARY;
         break;
      case DBUS_REQUEST_NAME_REPLY_IN_QUEUE:
         EasyDbusDebug ("Service in queue");
         result = EASYDBUS_CONN_NAME_SERVICE_IN_QUEUE;
         break;
      case DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER:
         EasyDbusDebug ("Service already owner");
         result = EASYDBUS_CONN_NAME_SERVICE_PRIMARY;
         break;
      default:
         EasyDbusDebug ("Error! Returned value not managed");
         return -1;
         break;
   }

   return result;
}

Here is the call graph for this function:

int easydbus_connect_to_bus	(	struct EasyDbus_core *	core,
		DBusError *	err,
		DBusBusType	type_bus
	)

Connect to dbus bus.

For internal use only.

Parameters:

	core	pointer to struct EasyDbus_core object.
	err	DBusError object pointer.
	type_bus	DBusBusType value with dbus bus type.

Returns:

-1 error

0 ok

Definition at line 237 of file acquire_internal.c.

References EasyDbus_core::conn, and EasyDbusDebug.

Referenced by easydbus_conn_reconnect(), easydbus_get_address_onsession(), easydbus_get_address_onsystem(), and easydbus_get_address_serverSession().

{
   /* connect to system bus */
   core->conn = dbus_bus_get (type_bus, err);
   if (!core->conn) {
      EasyDbusDebug ("Error %s from dbus_bus_get: %s",
                     err->name, err->message);
      return -1;
   }

   EasyDbusDebug ("Connected and registered to bus daemon");
   /* do not allw libdbus to exit on connection failure ( This
    * may around random exit () on SIGPIPE errors) */
   dbus_connection_set_exit_on_disconnect (core->conn, FALSE);
   return 0;
}

char* easydbus_found_new_name	(	struct EasyDbus_core *	core,
		char *	oldName,
		int	flags,
		DBusError *	err
	)

Found a new service name.

For internal use only.

Parameters:

	core	pointer to EasyDbus_core object
	oldName	old name used as prefix for new name
	flags	easydbus flags for connection
	err	pointer to DBusError object.

Returns:

NULL error

pointer to new service name string. Must be free.

Todo:

rename this function

Definition at line 152 of file acquire_name.c.

References EasyDbus_core::conn, easydbus_acquire_name(), EASYDBUS_RENAMED_MAX_TEST, EasyDbusDebug, and EasyDbus_core::service_name.

Referenced by easydbus_conn_reconnect(), easydbus_get_address_onsession(), easydbus_get_address_onsystem(), and easydbus_get_address_serverSession().

{
   char *service_name = NULL;
   int string_length = 0, string_length_max = 0;
   int i, result = -1;
   char buffer[5];

   // 1 --> for \0 and 3 --> for 3 char number.
   string_length_max = strlen (oldName) + 1 + 3;
   string_length = strlen (oldName) + 1;
   service_name = (char *) malloc (string_length_max);
   if (!service_name)
      return NULL;
   memset (service_name, 0, string_length_max);
   memcpy (service_name, oldName, string_length);

   EasyDbusDebug ("Check %s service name", oldName);
   for (i = 1; i < EASYDBUS_RENAMED_MAX_TEST; i++) {
      memset (buffer, 0, 5);
      snprintf (buffer, 5, "%d", i);
      memcpy (&service_name[string_length - 1],
              buffer, strlen (buffer) + 1);
      EasyDbusDebug ("Check %s service name", service_name);
      if (!dbus_bus_name_has_owner (core->conn, service_name, err)) {
         result = easydbus_acquire_name (core, service_name, 
                                         flags, err);
         if (result == -1)
            goto error;
         return service_name;
      }
   }

 error:

   if (service_name != NULL)
      free (service_name);

   return NULL;
}

Here is the call graph for this function:

int easydbus_get_address_onsession	(	struct EasyDbus_conn *	data,
		char *	serviceName
	)			[inline]

Acquire source address on session bus.

For internal use only.

Parameters:

	data	pointer to EasyDbus_conn object
	serviceName	name of service that must be acquired

See also:

enum easydbus_connection_flags.

Returns:

-1 error

EASYDBUS_CONN_NAME_SERVICE_EXISTS name service exists.

EASYDBUS_CONN_NAME_SERVICE_IN_QUEUE name service in queue.

EASYDBUS_CONN_NAME_SERVICE_PRIMARY name service is primary name.

EASYDBUS_CONN_NAME_SERVICE_RENAMED name service is been renamed.

Definition at line 162 of file acquire_internal.c.

References EasyDbus_core::conn, easydbus_acquire_name(), EASYDBUS_CONN_DO_NOT_QUEUE, EASYDBUS_CONN_NAME_SERVICE_EXISTS, EASYDBUS_CONN_NAME_SERVICE_RENAMED, EASYDBUS_CONN_NAME_UNIQUE, easydbus_connect_to_bus(), easydbus_found_new_name(), easydbus_save_serviceName(), easydbus_set_unique_nameID(), EasyDbusDebug, EasyDbus_conn::flags, EasyDbus_conn::registered_ondbus, and EasyDbus_core::service_name.

Referenced by easydbus_conn_get_address().

{
   struct EasyDbus_core *core = (struct EasyDbus_core *) data;
   DBusError err;
   int result = -1;
   char *new_service_name = NULL;

   dbus_error_init (&err);

   /* connect to system bus */
   if (easydbus_connect_to_bus (core, &err, DBUS_BUS_SESSION))
      goto error_acquire;

   result = easydbus_acquire_name (core, serviceName, 
                                   data->flags, &err);
   if (result == -1)
      goto error_acquire;

   if (result == EASYDBUS_CONN_NAME_SERVICE_EXISTS &&
       // probably this isn't needed because without this flags
       // return value is EASYDBUS_CONN_NAME_SERVICE_IN_QUEUE
       (data->flags & EASYDBUS_CONN_DO_NOT_QUEUE)) {
      if (data->flags & EASYDBUS_CONN_NAME_SERVICE_RENAMED) {
         new_service_name = easydbus_found_new_name
            (core, serviceName, data->flags, &err);
         if (new_service_name == NULL)
            goto error_acquire;
         result = EASYDBUS_CONN_NAME_SERVICE_RENAMED;
      }
      else
         goto error_acquire;
   }

   data->registered_ondbus = 1;

   if (new_service_name != NULL)
      core->service_name = new_service_name;
   else if (easydbus_save_serviceName (core, serviceName)) {
      EasyDbusDebug ("Error on save service name");
      goto error_acquire;
   }
   
   if (data->flags & EASYDBUS_CONN_NAME_UNIQUE)
      if (easydbus_set_unique_nameID (core, core->service_name))
         goto error_acquire;

   EasyDbusDebug ("Acquire operation terminated");

   dbus_error_free (&err);
   return result;

 error_acquire:
   if (data->registered_ondbus)
      dbus_bus_release_name (core->conn, 
                             core->service_name, &err);

   if (core->conn != NULL)
      dbus_connection_unref (core->conn);

   dbus_error_free (&err);

   return result;
}

Here is the call graph for this function:

int easydbus_get_address_onsystem	(	struct EasyDbus_conn *	data,
		char *	serviceName
	)			[inline]

Acquire source address for system dbus bus.

For internal use only.

Parameters:

	data	pointer to EasyDbus_conn object
	serviceName	name of service that must be acquired

See also:

enum easydbus_connection_flags.

Returns:

-1 error

EASYDBUS_CONN_NAME_SERVICE_EXISTS name service exists.

EASYDBUS_CONN_NAME_SERVICE_IN_QUEUE name service in queue.

EASYDBUS_CONN_NAME_SERVICE_PRIMARY name service is primary name.

EASYDBUS_CONN_NAME_SERVICE_RENAMED name service is been renamed.

Definition at line 269 of file acquire_internal.c.

References EasyDbus_core::conn, easydbus_acquire_name(), EASYDBUS_CONN_DO_NOT_QUEUE, EASYDBUS_CONN_NAME_SERVICE_EXISTS, EASYDBUS_CONN_NAME_SERVICE_RENAMED, EASYDBUS_CONN_NAME_UNIQUE, easydbus_connect_to_bus(), easydbus_found_new_name(), easydbus_save_serviceName(), easydbus_set_unique_nameID(), EasyDbusDebug, EasyDbus_conn::flags, EasyDbus_conn::registered_ondbus, and EasyDbus_core::service_name.

Referenced by easydbus_conn_get_address().

{
   struct EasyDbus_core *core = (struct EasyDbus_core *) data;
   DBusError err;
   int result = -1;
   char *new_service_name = NULL;

   dbus_error_init (&err);

   if (easydbus_connect_to_bus (core, &err, DBUS_BUS_SYSTEM))
      goto error_acquire;

   result = easydbus_acquire_name (core, serviceName, data->flags, 
                                   &err);
   if (result == -1)
      goto error_acquire;
   if (result == EASYDBUS_CONN_NAME_SERVICE_EXISTS &&
       // probably this isn't needed because without this flags
       // return value is EASYDBUS_CONN_NAME_SERVICE_IN_QUEUE
       (data->flags & EASYDBUS_CONN_DO_NOT_QUEUE)) {
      if (data->flags & EASYDBUS_CONN_NAME_SERVICE_RENAMED) {
         new_service_name = easydbus_found_new_name
            (core, serviceName, data->flags, &err);
         if (new_service_name == NULL)
            goto error_acquire;
         result = EASYDBUS_CONN_NAME_SERVICE_RENAMED;
      }
      else
         goto error_acquire;
   }

   data->registered_ondbus = 1;

   if (new_service_name != NULL)
      core->service_name = new_service_name;
   else if (easydbus_save_serviceName (core, serviceName)) {
      EasyDbusDebug ("Error on save service name");
      goto error_acquire;
   }

   if (data->flags & EASYDBUS_CONN_NAME_UNIQUE)
      if (easydbus_set_unique_nameID (core, core->service_name))
         goto error_acquire;

   dbus_error_free (&err);
   return result;

 error_acquire:
   if (data->registered_ondbus)
      dbus_bus_release_name (core->conn, 
                             core->service_name, &err);

   if (core->conn != NULL)
      dbus_connection_unref (core->conn);

   dbus_error_free (&err);

   return -1;
}

Here is the call graph for this function:

int easydbus_get_address_serverSession	(	struct EasyDbus_conn *	data,
		char *	serviceName
	)			[inline]

Acquire source addres for server on session bus.

For internal use only.

Parameters:

	data	pointer to EasyDbus_conn object
	serviceName	name of service that must be acquired

See also:

enum easydbus_connection_flags.

Returns:

-1 error

EASYDBUS_CONN_NAME_SERVICE_EXISTS name service exists.

EASYDBUS_CONN_NAME_SERVICE_IN_QUEUE name service in queue.

EASYDBUS_CONN_NAME_SERVICE_PRIMARY name service is primary name.

EASYDBUS_CONN_NAME_SERVICE_RENAMED name service is been renamed.

Definition at line 57 of file acquire_internal.c.

References EasyDbus_core::conn, easydbus_acquire_name(), EASYDBUS_CONN_DO_NOT_QUEUE, EASYDBUS_CONN_NAME_SERVICE_EXISTS, EASYDBUS_CONN_NAME_SERVICE_RENAMED, EASYDBUS_CONN_NAME_UNIQUE, easydbus_connect_to_bus(), easydbus_found_new_name(), easydbus_save_serviceName(), easydbus_set_unique_nameID(), EasyDbusDebug, EasyDbus_conn::flags, EasyDbus_conn::registered_ondbus, and EasyDbus_core::service_name.

Referenced by easydbus_conn_get_address().

{
   DBusError err;
   struct EasyDbus_core *core = (struct EasyDbus_core *) data;
   int result = -1;
   char *new_service_name = NULL;

   dbus_error_init (&err);

   if (easydbus_connect_to_bus (core, &err, DBUS_BUS_SESSION))
      goto error_acquire;

// if (dbus_bus_register (core->conn, &err) == FALSE) {
//    EasyDbusDebug ("Error %s from dbus_bus_register: %s",
//          err.name,
//          err.message);
//    goto error_acquire;
// }

   result = easydbus_acquire_name (core, serviceName,
                                   data->flags | EASYDBUS_CONN_DO_NOT_QUEUE,
                                   &err);
   if (result == -1)
      goto error_acquire;
   if (result == EASYDBUS_CONN_NAME_SERVICE_EXISTS) {
      // probably this isn't needed because without this flags
      // return value is EASYDBUS_CONN_NAME_SERVICE_IN_QUEUE
      if (data->flags & EASYDBUS_CONN_NAME_SERVICE_RENAMED) {
         new_service_name = easydbus_found_new_name
            (core, serviceName, data->flags, &err);
         if (new_service_name == NULL)
            goto error_acquire;
         result = EASYDBUS_CONN_NAME_SERVICE_RENAMED;
      }
      else
         goto error_acquire;
   }

   data->registered_ondbus = 1;

   if (new_service_name != NULL)
      core->service_name = new_service_name;
   else if (easydbus_save_serviceName (core, serviceName)) {
      EasyDbusDebug ("Error on save service name");
      goto error_acquire;
   }

   if (data->flags & EASYDBUS_CONN_NAME_UNIQUE)
      if (easydbus_set_unique_nameID (core, core->service_name))
         goto error_acquire;

   dbus_error_free (&err);
   return result;

 error_acquire:
   if (data->registered_ondbus)
      dbus_bus_release_name (core->conn, 
                             core->service_name, &err);

   if (core->conn != NULL)
      dbus_connection_unref (core->conn);

   dbus_error_free (&err);

   return -1;
}

Here is the call graph for this function:

int easydbus_set_request_flags

(

int

easydbus_flags

)

[inline]

Convert easydbus_connection_flags to dbus_flags.

For internal use only.

Parameters:

easydbus_flags

integer with easydbus connection flags.

Returns:

dbus_flags binding

Todo:

rename this function

Definition at line 55 of file acquire_name.c.

References EASYDBUS_CONN_ALLOW_REPLACEMENT, EASYDBUS_CONN_DO_NOT_QUEUE, EASYDBUS_CONN_REPLACE_EXISTING, and EasyDbusDebug.

Referenced by easydbus_acquire_name().

{
   int dbus_flags = 0;

   if (easydbus_flags & EASYDBUS_CONN_ALLOW_REPLACEMENT) {
      EasyDbusDebug ("Set ALLOW_REPLACEMENT flag");
      dbus_flags |= DBUS_NAME_FLAG_ALLOW_REPLACEMENT;
   }
   if (easydbus_flags & EASYDBUS_CONN_REPLACE_EXISTING) {
      EasyDbusDebug ("Set REPLACE_EXISTING flag");
      dbus_flags |= DBUS_NAME_FLAG_REPLACE_EXISTING;
   }
   if (easydbus_flags & EASYDBUS_CONN_DO_NOT_QUEUE) {
      EasyDbusDebug ("Set DO_NOT_QUEUE flag");
      dbus_flags |= DBUS_NAME_FLAG_DO_NOT_QUEUE;
   }

   return dbus_flags;
}

int easydbus_set_unique_nameID	(	struct EasyDbus_core *	core,
		char *	nameId
	)			[inline]

Set unique name ID.

For internal use only.

Parameters:

	core	pointer to struct EasyDbus_core object.
	nameId	new unique name id to set.

Returns:

-1 error

0 ok

Definition at line 134 of file acquire_internal.c.

References EasyDbus_core::conn, and EasyDbusDebug.

Referenced by easydbus_get_address_onsession(), easydbus_get_address_onsystem(), and easydbus_get_address_serverSession().

{
   EasyDbusDebug ("DBUS unique name = %s",
                  dbus_bus_get_unique_name (core->conn));

   if (!dbus_bus_set_unique_name (core->conn, nameId))
      return -1;

   EasyDbusDebug ("DBUS unique name = %s",
                  dbus_bus_get_unique_name (core->conn));

   return 0;
}

---