Main Page   Modules   Data Structures   File List   Data Fields   Related Pages  

DBusWatch implementation details
[D-BUS internal implementation details]

implementation details for DBusWatch. More...

Data Structures

struct  DBusWatch
 Implementation of DBusWatch. More...

struct  DBusWatchList
 DBusWatchList implementation details. More...


Typedefs

typedef DBusWatchList DBusWatchList
 Opaque data type representing a list of watches and a set of DBusAddWatchFunction/DBusRemoveWatchFunction. More...


Functions

DBusWatch_dbus_watch_new (int fd, unsigned int flags, dbus_bool_t enabled, DBusWatchHandler handler, void *data, DBusFreeFunction free_data_function)
 Creates a new DBusWatch. More...

DBusWatch_dbus_watch_ref (DBusWatch *watch)
 Increments the reference count of a DBusWatch object. More...

void _dbus_watch_unref (DBusWatch *watch)
 Decrements the reference count of a DBusWatch object and finalizes the object if the count reaches zero. More...

void _dbus_watch_invalidate (DBusWatch *watch)
 Clears the file descriptor from a now-invalid watch object so that no one tries to use it. More...

void _dbus_watch_sanitize_condition (DBusWatch *watch, unsigned int *condition)
 Sanitizes the given condition so that it only contains flags that the DBusWatch requested. More...

DBusWatchList_dbus_watch_list_new (void)
 Creates a new watch list. More...

void _dbus_watch_list_free (DBusWatchList *watch_list)
 Frees a DBusWatchList. More...

dbus_bool_t _dbus_watch_list_set_functions (DBusWatchList *watch_list, DBusAddWatchFunction add_function, DBusRemoveWatchFunction remove_function, DBusWatchToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function)
 Sets the watch functions. More...

dbus_bool_t _dbus_watch_list_add_watch (DBusWatchList *watch_list, DBusWatch *watch)
 Adds a new watch to the watch list, invoking the application DBusAddWatchFunction if appropriate. More...

void _dbus_watch_list_remove_watch (DBusWatchList *watch_list, DBusWatch *watch)
 Removes a watch from the watch list, invoking the application's DBusRemoveWatchFunction if appropriate. More...

void _dbus_watch_list_toggle_watch (DBusWatchList *watch_list, DBusWatch *watch, dbus_bool_t enabled)
 Sets a watch to the given enabled state, invoking the application's DBusWatchToggledFunction if appropriate. More...

void _dbus_watch_set_handler (DBusWatch *watch, DBusWatchHandler handler, void *data, DBusFreeFunction free_data_function)
 Sets the handler for the watch. More...


Detailed Description

implementation details for DBusWatch.


Typedef Documentation

DBusWatchList
 

Opaque data type representing a list of watches and a set of DBusAddWatchFunction/DBusRemoveWatchFunction.

Automatically handles removing/re-adding watches when the DBusAddWatchFunction is updated or changed. Holds a reference count to each watch.

Used in the implementation of both DBusServer and DBusClient.

Definition at line 33 of file dbus-watch.h.


Function Documentation

void _dbus_watch_invalidate DBusWatch   watch
 

Clears the file descriptor from a now-invalid watch object so that no one tries to use it.

This is because a watch may stay alive due to reference counts after the file descriptor is closed. Invalidation makes it easier to catch bugs. It also keeps people from doing dorky things like assuming file descriptors are unique (never recycled).

Parameters:
watch  the watch object.

Definition at line 145 of file dbus-watch.c.

References DBusWatch::fd, and DBusWatch::flags.

dbus_bool_t _dbus_watch_list_add_watch DBusWatchList   watch_list,
DBusWatch   watch
 

Adds a new watch to the watch list, invoking the application DBusAddWatchFunction if appropriate.

Parameters:
watch_list  the watch list.
watch  the watch to add.
Returns:
TRUE on success, FALSE if no memory.

Definition at line 332 of file dbus-watch.c.

References DBusWatchList::add_watch_function, DBusWatchList::watch_data, and DBusWatchList::watches.

void _dbus_watch_list_free DBusWatchList   watch_list
 

Frees a DBusWatchList.

Parameters:
watch_list  the watch list.

Definition at line 225 of file dbus-watch.c.

References DBusWatchList::watches.

DBusWatchList* _dbus_watch_list_new void   
 

Creates a new watch list.

Returns NULL if insufficient memory exists.

Returns:
the new watch list, or NULL on failure.

Definition at line 208 of file dbus-watch.c.

void _dbus_watch_list_remove_watch DBusWatchList   watch_list,
DBusWatch   watch
 

Removes a watch from the watch list, invoking the application's DBusRemoveWatchFunction if appropriate.

Parameters:
watch_list  the watch list.
watch  the watch to remove.

Definition at line 365 of file dbus-watch.c.

References DBusWatchList::remove_watch_function, DBusWatchList::watch_data, and DBusWatchList::watches.

dbus_bool_t _dbus_watch_list_set_functions DBusWatchList   watch_list,
DBusAddWatchFunction    add_function,
DBusRemoveWatchFunction    remove_function,
DBusWatchToggledFunction    toggled_function,
void *    data,
DBusFreeFunction    free_data_function
 

Sets the watch functions.

This function is the "backend" for dbus_connection_set_watch_functions() and dbus_server_set_watch_functions().

Parameters:
watch_list  the watch list.
add_function  the add watch function.
remove_function  the remove watch function.
toggled_function  function on toggling enabled flag, or NULL
data  the data for those functions.
free_data_function  the function to free the data.
Returns:
FALSE if not enough memory

Definition at line 253 of file dbus-watch.c.

References DBusWatchList::add_watch_function, DBusList::data, DBusWatchList::remove_watch_function, DBusWatchList::watch_data, DBusWatchList::watch_free_data_function, DBusWatchList::watch_toggled_function, and DBusWatchList::watches.

void _dbus_watch_list_toggle_watch DBusWatchList   watch_list,
DBusWatch   watch,
dbus_bool_t    enabled
 

Sets a watch to the given enabled state, invoking the application's DBusWatchToggledFunction if appropriate.

Parameters:
watch_list  the watch list.
watch  the watch to toggle.
enabled  TRUE to enable

Definition at line 392 of file dbus-watch.c.

References DBusWatch::enabled, DBusWatchList::watch_data, and DBusWatchList::watch_toggled_function.

DBusWatch* _dbus_watch_new int    fd,
unsigned int    flags,
dbus_bool_t    enabled,
DBusWatchHandler    handler,
void *    data,
DBusFreeFunction    free_data_function
 

Creates a new DBusWatch.

Used to add a file descriptor to be polled by a main loop.

Parameters:
fd  the file descriptor to be watched.
flags  the conditions to watch for on the descriptor.
enabled  the initial enabled state
handler  the handler function
data  data for handler function
free_data_function  function to free the data
Returns:
the new DBusWatch object.

Definition at line 67 of file dbus-watch.c.

References DBusWatch::enabled, DBusWatch::fd, DBusWatch::flags, DBusWatch::free_handler_data_function, DBusWatch::handler, DBusWatch::handler_data, and DBusWatch::refcount.

DBusWatch* _dbus_watch_ref DBusWatch   watch
 

Increments the reference count of a DBusWatch object.

Parameters:
watch  the watch object.
Returns:
the watch object.

Definition at line 103 of file dbus-watch.c.

References DBusWatch::refcount.

void _dbus_watch_sanitize_condition DBusWatch   watch,
unsigned int *    condition
 

Sanitizes the given condition so that it only contains flags that the DBusWatch requested.

e.g. if the watch is a DBUS_WATCH_READABLE watch then DBUS_WATCH_WRITABLE will be stripped from the condition.

Parameters:
watch  the watch object.
condition  address of the condition to sanitize.

Definition at line 161 of file dbus-watch.c.

References DBusWatch::flags.

void _dbus_watch_set_handler DBusWatch   watch,
DBusWatchHandler    handler,
void *    data,
DBusFreeFunction    free_data_function
 

Sets the handler for the watch.

Todo:
this function only exists because of the weird way connection watches are done, see the note in docs for _dbus_connection_handle_watch().
Parameters:
watch  the watch
handler  the new handler
data  the data
free_data_function  free data with this

Definition at line 426 of file dbus-watch.c.

References DBusWatch::free_handler_data_function, DBusWatch::handler, and DBusWatch::handler_data.

void _dbus_watch_unref DBusWatch   watch
 

Decrements the reference count of a DBusWatch object and finalizes the object if the count reaches zero.

Parameters:
watch  the watch object.

Definition at line 117 of file dbus-watch.c.

References DBusWatch::free_handler_data_function, DBusWatch::handler_data, and DBusWatch::refcount.


Generated on Wed Jun 9 05:01:28 2004 for D-BUS by doxygen1.2.15