watcher_internal
[monitor_internal]

Collaboration diagram for watcher_internal:

---

Detailed Description

Module for manage EasyDbus_watcher object

This module is under hard development phase and could be change on new versions.

EasyDbus_watcher 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
dbus_bool_t	easydbus_add_watch_callback (DBusWatch *watch, void *data)
	Hander for manage new watcher.
void	easydbus_remove_watch_callback (DBusWatch *watch, void *data)
	Handler of remove watch callback.
int	easydbus_watcher_add (struct EasyDbus_core *core, struct EasyDbus_watcher *watcher)
	Add EasyDbus_watcher object on watchers list and call user callback.
EasyDbus_watcher *	easydbus_watcher_create_skeleton (void)
	Create EasyDbus_watcher skeleton object.
struct EasyDbus_watcher *	easydbus_watcher_get_from_fd (struct EasyDbus_watcher *list, int fd, enum easydbus_watcher_flags flags)
	Find EasyDbus_watcher object from file descriptor.
EasyDbus_watcher *	easydbus_watcher_get_from_watch (EasyDbus_watcher *list, DBusWatch *watch)
	Recover EasyDbus_watcher from DBusWatch object.
int	easydbus_watcher_remove_dbus_watch (struct EasyDbus_core *core, DBusWatch *watch)
	Found EasyDbus_watcher object connect to DBusWatch and remove it from list.

---

Function Documentation

dbus_bool_t easydbus_add_watch_callback	(	DBusWatch *	watch,
		void *	data
	)

Hander for manage new watcher.

Parameters:

	watch	pointer to new DBusWatch object to add.
	data	pointer to EasyDbus_core object.

Returns:

TRUE

FALSE

For internal use only.

Definition at line 114 of file watch_events_internal.c.

References easydbus_watcher_add(), easydbus_watcher_create_skeleton(), easydbus_watcher_get_from_watch(), EasyDbusDebug, EasyDbus_core::user_data, EasyDbus_watcher::watch, EasyDbus_core::watcher, EasyDbus_conn::watcher_add_cb, and EasyDbus_conn::watcher_closure.

Referenced by easydbus_watcher_enable().

{
   struct EasyDbus_core *core = (struct EasyDbus_core *) data;
   struct EasyDbus_watcher *watcher = NULL;
   int flags = 0, fd = 0;

   flags = dbus_watch_get_flags (watch);
#if defined(__DBUS_VERSION__) && (__DBUS_VERSION__ <= 102)
   fd = dbus_watch_get_fd (watch);
#else
   fd = dbus_watch_get_unix_fd (watch);
#endif

   watcher = easydbus_watcher_get_from_watch (core->watcher,
                                              watch);
   if (watcher) {
      // if watcher is already on list
      EasyDbusDebug ("Enable already create watcher (%p %s) "
                     "with fd %d",
                     watch, 
                     (flags & DBUS_WATCH_READABLE ? "readable" :
                      ((flags & DBUS_WATCH_WRITABLE) ? "writable" : 
                        "error" )), fd);
      
      core->user_data.watcher_add_cb (watcher, 
                                      core->user_data.watcher_closure);
   } else {
      dbus_watch_set_data (watch, data, NULL);
      watcher = easydbus_watcher_create_skeleton ();
      // see how manage this exception
      if (watcher == NULL)
         return FALSE;

      watcher->watch = watch;
      easydbus_watcher_add (core, watcher);

      EasyDbusDebug ("Add %s watcher (%p %s) with fd %d", 
                     (flags & DBUS_WATCH_READABLE ? "readable" :
                      ((flags & DBUS_WATCH_WRITABLE) ? "writable" : 
                        "error" )), watch, 
                     dbus_watch_get_enabled (watch) ? "enable" : "not enable",
                     fd);
   }
   return TRUE;
}

Here is the call graph for this function:

void easydbus_remove_watch_callback	(	DBusWatch *	watch,
		void *	data
	)

Handler of remove watch callback.

Parameters:

	watch	DBusWatch object pointer that will be removed.
	data	Closure data.

For internal use only.

Definition at line 168 of file watch_events_internal.c.

References easydbus_watcher_remove_dbus_watch(), and EasyDbusDebug.

Referenced by easydbus_toggle_watch_callback(), and easydbus_watcher_enable().

{
   struct EasyDbus_core *core = (struct EasyDbus_core *) data;
   int flags = 0;
   
   flags = dbus_watch_get_flags (watch);

   if (easydbus_watcher_remove_dbus_watch (core, watch))
     EasyDbusDebug ("Error on remove watcher (%s) with fd "
                    "%d or already removed.",
                    (flags & DBUS_WATCH_READABLE ? "readable" :
                     ((flags & DBUS_WATCH_WRITABLE) ? "writable" : 
                       "error" )), 
#if defined(__DBUS_VERSION__) && (__DBUS_VERSION__ <= 102)
                    dbus_watch_get_fd (watch));
#else
                    dbus_watch_get_unix_fd (watch));
#endif
   else
    EasyDbusDebug ("Remove Watcher (%s) with fd = %d",
                   (flags & DBUS_WATCH_READABLE ? "readable" :
                    ((flags & DBUS_WATCH_WRITABLE) ? "writable" : 
                      "error" )),
#if defined(__DBUS_VERSION__) && (__DBUS_VERSION__ <= 102)
                   dbus_watch_get_fd (watch));
#else
                  dbus_watch_get_unix_fd(watch));
#endif
}

Here is the call graph for this function:

int easydbus_watcher_add	(	struct EasyDbus_core *	core,
		struct EasyDbus_watcher *	watcher
	)

Add EasyDbus_watcher object on watchers list and call user callback.

Parameters:

	core	EasyDbus_core object pointer
	watcher	EasyDbus_watcher object pointer to add.

Returns:

-1 on error

0 ok

For internal use only.

Definition at line 78 of file watcher.c.

References EasyDbus_watcher::core, EasyDbus_watcher::next, EasyDbus_core::user_data, EasyDbus_watcher::watch, EasyDbus_core::watcher, EasyDbus_conn::watcher_add_cb, and EasyDbus_conn::watcher_closure.

Referenced by easydbus_add_watch_callback().

{
   struct EasyDbus_watcher *watch = NULL;

   if (!core || !watcher)
      return -1;

   if (!core->watcher) {
      // no watcher
      core->watcher = watcher;
   }
   else {
      watch = core->watcher;
      while (watch->next)
         watch = watch->next;
      watch->next = watcher;
   }
   watcher->core = core;
   if (dbus_watch_get_enabled (watcher->watch))
      core->user_data.watcher_add_cb (watcher, 
                                      core->user_data.watcher_closure);
   return 0;
}

EasyDbus_watcher* easydbus_watcher_create_skeleton

(

void

)

[read]

Create EasyDbus_watcher skeleton object.

Returns:

NULL on error

pointer to a new EasyDbus_watcher skeleton.

For internal use only.

Definition at line 50 of file watcher.c.

References EasyDbus_watcher::next, and EasyDbus_watcher::watch.

Referenced by easydbus_add_watch_callback().

{
   struct EasyDbus_watcher *watcher = NULL;

   watcher = (struct EasyDbus_watcher *)
      malloc (sizeof (struct EasyDbus_watcher));

   if (!watcher)
      return NULL;

   memset (watcher, 0, sizeof (struct EasyDbus_watcher));

   watcher->watch = NULL;
   watcher->next = NULL;

   return watcher;
}

struct EasyDbus_watcher* easydbus_watcher_get_from_fd	(	struct EasyDbus_watcher *	list,
		int	fd,
		enum easydbus_watcher_flags	flags
	)			[read]

Find EasyDbus_watcher object from file descriptor.

Parameters:

	list	pointer to EasyDbus_watcher list.
	fd	file descriptor used for research.
	flags	EASYDBUS_WATCHER_READABLE | EASYDBUS_WATCHER_WRITABLE

Returns:

NULL on error or if there is a watcher for fd descriptor.

pointer to struct EasyDbus_watcher on list that watchs a file descriptor equal to fd.

For internal use only.

Definition at line 156 of file watcher.c.

References EASYDBUS_WATCHER_READABLE, EasyDbus_watcher::next, and EasyDbus_watcher::watch.

Referenced by easydbus_object_handle_message().

{
   if (!list || fd < 0)
      return NULL;

   while (list) {
      if (list->watch) {
         if (dbus_watch_get_enabled (list->watch))
#if defined(__DBUS_VERSION__) && (__DBUS_VERSION__ <= 102)
            if (dbus_watch_get_fd (list->watch) == fd) {
#else
            if (dbus_watch_get_unix_fd (list->watch) == fd) {
#endif
               if (dbus_watch_get_flags (list->watch) & 
                   (flags & EASYDBUS_WATCHER_READABLE ? DBUS_WATCH_READABLE : 
                     DBUS_WATCH_WRITABLE))
               return list;
            }
      }
      list = list->next;
   }

   return NULL;
}

EasyDbus_watcher* easydbus_watcher_get_from_watch	(	EasyDbus_watcher *	list,
		DBusWatch *	watch
	)			[read]

Recover EasyDbus_watcher from DBusWatch object.

Parameters:

	list	watchers list pointer
	watch	pointer to DBusWatch object to found

Returns:

NULL if object is not founded

pointer to EasyDbus_watcher object.

For internal use only.

Definition at line 192 of file watcher.c.

References EasyDbus_watcher::next, and EasyDbus_watcher::watch.

Referenced by easydbus_add_watch_callback().

{
   if (list && watch)
      while (list) {
         if (list->watch == watch)
            return list;
         list = list->next;
      }

   return NULL;
}

int easydbus_watcher_remove_dbus_watch	(	struct EasyDbus_core *	core,
		DBusWatch *	watch
	)

Found EasyDbus_watcher object connect to DBusWatch and remove it from list.

Parameters:

	core	EasyDbus_core object pointer
	watch	DBusWatch object pointer to remove

Returns:

-1 on error

0 ok

For internal use only.

TODO see problem with valgrind with this instruction.

Definition at line 113 of file watcher.c.

References EasyDbus_watcher::next, EasyDbus_core::user_data, EasyDbus_watcher::watch, EasyDbus_core::watcher, EasyDbus_conn::watcher_closure, and EasyDbus_conn::watcher_remove_cb.

Referenced by easydbus_remove_watch_callback().

{
   struct EasyDbus_watcher *current, *prev;

   if (!watch || !core)
      return -1;

   prev = current = core->watcher;

   while (current) {
      if (watch == current->watch) {
         if (core->user_data.watcher_remove_cb &&
             dbus_watch_get_enabled (watch))
            core->user_data.watcher_remove_cb (current, 
                                               core->user_data.watcher_closure);
         if (prev == current)
            core->watcher = current->next;
         else
            prev->next = current->next;
         free (current);
         return 0;
      }
      prev = current;
      current = current->next;
   }

   return -1;
}

---