purple. More...
#include "value.h"
#include "dbus-types.h"
Include dependency graph for dbus-server.h:
Go to the source code of this file.
Data Structures | |
struct | _PurpleDBusType |
Defines | |
#define | PURPLE_DBUS_TYPE(type) (&PURPLE_DBUS_TYPE_##type) |
#define | PURPLE_DBUS_DECLARE_TYPE(type) extern PurpleDBusType PURPLE_DBUS_TYPE_##type; |
#define | PURPLE_DBUS_DEFINE_TYPE(type) PurpleDBusType PURPLE_DBUS_TYPE_##type = { NULL }; |
#define | PURPLE_DBUS_DEFINE_INHERITING_TYPE(type, parent) PurpleDBusType PURPLE_DBUS_TYPE_##type = { PURPLE_DBUS_TYPE(parent) }; |
#define | PURPLE_DBUS_RETURN_FALSE_IF_DISABLED(plugin) |
#define | DBUS_EXPORT |
Macro DBUS_EXPORT expands to nothing. | |
Functions | |
void | purple_dbus_init_ids (void) |
Initializes purple dbus pointer registration engine. | |
void | purple_dbus_register_pointer (gpointer node, PurpleDBusType *type) |
Registers a typed pointer. | |
void | purple_dbus_unregister_pointer (gpointer node) |
Unregisters a pointer previously registered with purple_dbus_register_pointer. | |
void | purple_dbus_signal_emit_purple (const char *name, int num_values, PurpleValue **values, va_list vargs) |
Emits a dbus signal. | |
const char * | purple_dbus_get_init_error (void) |
Returns whether Purple's D-BUS subsystem is up and running. | |
void * | purple_dbus_get_handle (void) |
Returns the dbus subsystem handle. | |
gboolean | purple_dbus_is_owner (void) |
Determines whether this instance owns the DBus service name. | |
void | purple_dbus_init (void) |
Starts Purple's D-BUS server. | |
void | purple_dbus_uninit (void) |
Uninitializes Purple's D-BUS server. | |
Variables | |
typedefG_BEGIN_DECLS struct _PurpleDBusType | PurpleDBusType |
Types of pointers are identified by the ADDRESS of a PurpleDbusType object. |
purple.
Purple is the legal property of its developers, whose names are too numerous to list here. Please refer to the COPYRIGHT file distributed with this source distribution.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
Macro DBUS_EXPORT expands to nothing. It is used to indicate to the dbus-analize-functions.py script that the given function should be available to other applications through DBUS. If dbus-analize-functions.py is run without the "--export-only" option, this prefix is ignored. |
|
Value: if (purple_dbus_get_init_error() != NULL) \ { \ gchar *title; \ title = g_strdup_printf("Unable to Load %s Plugin", plugin->info->name); \ purple_notify_error(NULL, title, \ _("Purple's D-BUS server is not running for the reason listed below"), \ _(purple_dbus_get_init_error())); \ g_free(title); \ return FALSE; \ } |
|
Returns the dbus subsystem handle.
|
|
Returns whether Purple's D-BUS subsystem is up and running. If it's NOT running then purple_dbus_dispatch_init() failed for some reason, and a message should have been purple_debug_error()'ed. Purple plugins that use D-BUS should use the PURPLE_DBUS_RETURN_FALSE_IF_DISABLED macro to short-circuit initialization if Purple's D-BUS subsystem is not running.
|
|
Starts Purple's D-BUS server. It is responsible for handling DBUS requests from other applications. |
|
Initializes purple dbus pointer registration engine. Remote dbus applications need a way of addressing objects exposed by purple to the outside world. In purple itself, these objects (such as PurpleBuddy and company) are identified by pointers. The purple dbus pointer registration engine converts pointers to handles and back. In order for an object to participate in the scheme, it must register itself and its type with the engine. This registration allocates an integer id which can be resolved to the pointer and back. Handles are not persistent. They are reissued every time purple is started. This is not good; external applications that use purple should work even whether purple was restarted in the middle of the interaction. Pointer registration is only a temporary solution. When PurpleBuddy and similar structures have been converted into gobjects, this registration will be done automatically by objects themselves. By the way, this kind of object-handle translation should be so common that there must be a library (maybe even glib) that implements it. I feel a bit like reinventing the wheel here. |
|
Determines whether this instance owns the DBus service name.
|
|
Registers a typed pointer.
|
|
Emits a dbus signal.
|
|
Unregisters a pointer previously registered with purple_dbus_register_pointer.
|
|
Types of pointers are identified by the ADDRESS of a PurpleDbusType object. This way, plugins can easily access types defined in purple proper as well as introduce their own types that will not conflict with those introduced by other plugins.
The structure PurpleDbusType has only one element (PurpleDBusType::parent), a contains a pointer to the parent type, or |