Enlightenment CVS committal
Author : rephorm
Project : e17
Module : proto
Dir : e17/proto/e_dbus/src/lib/dbus
Modified Files:
e_dbus.c e_dbus_object.c e_dbus_signal.c
Log Message:
some quick docs (not being generated yet)
===================================================================
RCS file: /cvs/e/e17/proto/e_dbus/src/lib/dbus/e_dbus.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- e_dbus.c 15 Mar 2007 08:59:19 -0000 1.1
+++ e_dbus.c 15 Mar 2007 09:18:54 -0000 1.2
@@ -397,7 +397,10 @@
return 1;
}
-/* XXX should this be separated from the watch/timeout setup code? what
happens when this is called more than once in a single process? */
+/**
+ * Retrieve a connection to the bus and integrate it with the ecore main loop.
+ * @param type the type of bus to connect to, e.g. DBUS_BUS_SYSTEM or
DBUS_BUS_SESSION
+ */
DBusConnection *
e_dbus_bus_get(DBusBusType type)
{
@@ -473,6 +476,10 @@
}
+/**
+ * Close out a connection retrieved with e_dbus_bus_get()
+ * @param conn the connection to close
+ */
void
e_dbus_connection_close(DBusConnection *conn)
{
@@ -501,6 +508,9 @@
dbus_connection_unref(conn);
}
+/**
+ * @brief Initialize e_dbus
+ */
int
e_dbus_init(void)
{
@@ -512,6 +522,9 @@
return init;
}
+/**
+ * Shutdown e_dbus.
+ */
void
e_dbus_shutdown(void)
{
===================================================================
RCS file: /cvs/e/e17/proto/e_dbus/src/lib/dbus/e_dbus_object.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- e_dbus_object.c 15 Mar 2007 08:59:19 -0000 1.1
+++ e_dbus_object.c 15 Mar 2007 09:18:54 -0000 1.2
@@ -89,6 +89,10 @@
#endif
/**
* Add a dbus object.
+ *
+ * @param conn the connection on with the object should listen
+ * @param object_path a unique string identifying an object (e.g.
org/enlightenment/WindowManager
+ * @param data custom data to set on the object (obj->data XXX this needs an
api)
*/
E_DBus_Object *
e_dbus_object_add(DBusConnection *conn, const char *object_path, void *data)
@@ -116,6 +120,11 @@
return obj;
}
+/**
+ * Free a dbus object
+ *
+ * @param obj the object to free
+ */
void
e_dbus_object_free(E_DBus_Object *obj)
{
===================================================================
RCS file: /cvs/e/e17/proto/e_dbus/src/lib/dbus/e_dbus_signal.c,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -3 -r1.1 -r1.2
--- e_dbus_signal.c 15 Mar 2007 08:59:19 -0000 1.1
+++ e_dbus_signal.c 15 Mar 2007 09:18:54 -0000 1.2
@@ -28,6 +28,10 @@
void e_dbus_signal_handler_free(E_DBus_Signal_Handler *sh);
+/**
+ * Initialize the signal subsystem
+ * @internal
+ */
int
e_dbus_signal_init(void)
{
@@ -40,6 +44,10 @@
return init;
}
+/**
+ * Shutdown the signal subsystem
+ * @internal
+ */
void
e_dbus_signal_shutdown(void)
{
@@ -51,6 +59,10 @@
event_handler = NULL;
}
+/**
+ * Free a signal handler
+ * @param sh the signal handler to free
+ */
void
e_dbus_signal_handler_free(E_DBus_Signal_Handler *sh)
{
@@ -63,7 +75,7 @@
free(sh);
}
-void
+static void
cb_name_owner(void *data, DBusMessage *msg)
{
DBusError err;
@@ -91,7 +103,7 @@
}
-void
+static void
cb_name_owner_error(void *data, const char *error_name, const char *error_msg)
{
E_DBus_Signal_Handler *sh;
@@ -103,7 +115,17 @@
}
}
-
+/**
+ * Add a signal handler
+ *
+ * @param conn the dbus connection
+ * @param bus name of the signal's sender
+ * @param path the object path of the signal's sender
+ * @param interface the signal's interface
+ * @param memeber the signal's name
+ * @param cb_signal a callback to call when the signal is received
+ * @param data custom data to pass in to the callback
+ */
E_DBus_Signal_Handler *
e_dbus_signal_handler_add(DBusConnection *conn, const char *sender, const char
*path, const char *interface, const char *member, E_DBus_Signal_Cb cb_signal,
void *data)
{
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys-and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
