obj_interface
[object]

Collaboration diagram for obj_interface:

---

Detailed Description

Module for manage Object interfaces

TO COMPLETE

Obj_Interface 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
int	easydbus_obj_interface_add_method (EasyDbus_obj_interface *interface, EasyDbus_obj_method *method)
	Add method to interface.
int	easydbus_obj_interface_add_signal (EasyDbus_obj_interface *interface, EasyDbus_obj_signal *signal)
	Add signal to interface.
EasyDbus_obj_interface *	easydbus_obj_interface_create_skeleton (char *name)
	Create EasyDbus_obj_interface object for define an interface of an object.
void	easydbus_obj_interface_free_skeleton (EasyDbus_obj_interface *interface)
	Free EasyDbus_obj_interface object.
EasyDbus_obj_method *	easydbus_obj_interface_get_method (const char *member_name, const char *interface_string, const EasyDbus_obj_interface *interface)
	Found method object from EasyDbus_obj_interface object.

---

Function Documentation

int easydbus_obj_interface_add_method	(	EasyDbus_obj_interface *	interface,
		EasyDbus_obj_method *	method
	)

Add method to interface.

Parameters:

	interface	EasyDbus_obj_interface object pointer where it is inserted method.
	method	EasyDbus_obj_method object to insert on interface

Returns:

-1 error

0 ok

Definition at line 108 of file register_interface.c.

References EasyDbusDebug, EasyDbus_obj_interface::handled_methods, EasyDbus_obj_interface::n_methods, and EasyDbus_obj_method::next.

{
   struct EasyDbus_obj_method *temp;

   if (!interface || !method)
      return -1;

   if (interface->n_methods) {
      temp = interface->handled_methods;
      while (temp->next)
         temp = temp->next;
      temp->next = method;
   }
   else
      interface->handled_methods = method;
   interface->n_methods++;

   EasyDbusDebug ("Added method to interface skeleton");

   return 0;
}

int easydbus_obj_interface_add_signal	(	EasyDbus_obj_interface *	interface,
		EasyDbus_obj_signal *	signal
	)

Add signal to interface.

Parameters:

	interface	EasyDbus_obj_interface object pointer where it is inserted signal.
	signal	EasyDbus_obj_signal object to insert on interface

Returns:

-1 error

0 ok

Definition at line 142 of file register_interface.c.

References EasyDbusDebug, EasyDbus_obj_interface::handled_signals, EasyDbus_obj_interface::n_signals, and EasyDbus_obj_signal::next.

{
   struct EasyDbus_obj_signal *temp = NULL;

   if (!interface || !signal)
      return -1;

   if (interface->n_signals) {
      temp = interface->handled_signals;
      while (temp->next)
         temp = temp->next;
      temp->next = signal;
   }
   else
      interface->handled_signals = signal;
   interface->n_signals++;

   EasyDbusDebug ("Added signal to skeleton interface");

   return 0;
}

EasyDbus_obj_interface* easydbus_obj_interface_create_skeleton

(

char *

name

)

Create EasyDbus_obj_interface object for define an interface of an object.

Parameters:

name

name of interface

Returns:

EasyDbus_obj_interface object pointer.

NULL on error

Definition at line 59 of file register_interface.c.

References EASYDBUS_MEMCOPY, EasyDbusDebug, EasyDbus_obj_interface::handled_methods, EasyDbus_obj_interface::handled_signals, and EasyDbus_obj_interface::name.

{
   struct EasyDbus_obj_interface *interface = NULL;
   unsigned int name_length = 0;

   if (!name)
      return NULL;

   interface = (struct EasyDbus_obj_interface *)
      malloc (sizeof (struct EasyDbus_obj_interface));
   if (!interface)
      return NULL;

   memset (interface, 0, sizeof (struct EasyDbus_obj_interface));

   interface->name = NULL;
   interface->handled_signals = NULL;
   interface->handled_methods = NULL;

   if (name) {
      name_length = strlen (name) + 1;
      interface->name = (char *) malloc (name_length);
      if (!interface->name)
         goto out_of_memory;

      EASYDBUS_MEMCOPY (interface->name, name, name_length);
   }

   EasyDbusDebug ("Create Interface Skeleton struct with name %s",
                  name);

   return interface;
 out_of_memory:
   if (interface)
      free (interface);
   return NULL;
}

void easydbus_obj_interface_free_skeleton

(

EasyDbus_obj_interface *

interface

)

Free EasyDbus_obj_interface object.

Parameters:

interface

EasyDbus_obj_interface object

Definition at line 171 of file register_interface.c.

References easydbus_obj_method_free(), easydbus_obj_signal_free(), EasyDbusDebug, EasyDbus_obj_interface::handled_methods, EasyDbus_obj_interface::handled_signals, EasyDbus_obj_interface::n_methods, EasyDbus_obj_interface::n_signals, EasyDbus_obj_interface::name, EasyDbus_obj_signal::next, and EasyDbus_obj_method::next.

Referenced by easydbus_object_free_skeleton().

{
   struct EasyDbus_obj_signal *signal;
   struct EasyDbus_obj_method *method;
   int i;

   if (!interface)
      return;

   if (interface->name)
      free (interface->name);

   if (interface->n_methods) {
      for (i = 0; i < interface->n_methods; i++) {
         method = interface->handled_methods;
         if (method)
            interface->handled_methods = method->next;
         easydbus_obj_method_free (method);
      }
   }

   if (interface->n_signals) {
      for (i = 0; i < interface->n_methods; i++) {
         signal = interface->handled_signals;
         if (signal)
            interface->handled_signals = signal->next;
         easydbus_obj_signal_free (signal);
      }
   }
   free (interface);
   EasyDbusDebug ("Free Interface skeleton");
}

Here is the call graph for this function:

EasyDbus_obj_method* easydbus_obj_interface_get_method	(	const char *	member_name,
		const char *	interface_string,
		const EasyDbus_obj_interface *	interface
	)

Found method object from EasyDbus_obj_interface object.

Parameters:

	member_name	method name
	interface_string	interface string
	interface	EasyDbus_obj_interface object pointer

Returns:

NULL error or method not found.

pointer to method founded.

Definition at line 213 of file register_interface.c.

References EasyDbus_obj_interface::handled_methods, EasyDbus_obj_interface::name, EasyDbus_obj_method::name, and EasyDbus_obj_method::next.

Referenced by easydbus_verify_match_and_prepare_reply().

{
   EasyDbus_obj_method *method = NULL;

   if (!member_name || !interface)
      return NULL;

   for (method = interface->handled_methods; method;
        method = method->next) {
      // check member
      if (!strcmp (member_name, method->name)) {
         if (interface_string) {
            if (!strcmp (interface_string, interface->name))
               break;
         } else
            // if interface isn't set and method matching,
            // then first method matching it is used.
            break;
      }
   }

   return method;
}

---