Typedefs | |
typedef DBusServer | DBusServer |
An opaque object representing a server that listens for connections from other applications. | |
Functions | |
DBusServer * | dbus_server_listen (const char *address, DBusError *error) |
Listens for new connections on the given address. | |
DBusServer * | dbus_server_ref (DBusServer *server) |
Increments the reference count of a DBusServer. | |
void | dbus_server_unref (DBusServer *server) |
Decrements the reference count of a DBusServer. | |
void | _dbus_server_ref_unlocked (DBusServer *server) |
Like dbus_server_ref() but does not acquire the lock (must already be held). | |
void | _dbus_server_unref_unlocked (DBusServer *server) |
Like dbus_server_unref() but does not acquire the lock (must already be held). | |
void | dbus_server_disconnect (DBusServer *server) |
Releases the server's address and stops listening for new clients. | |
dbus_bool_t | dbus_server_get_is_connected (DBusServer *server) |
Returns TRUE if the server is still listening for new connections. | |
char * | dbus_server_get_address (DBusServer *server) |
Returns the address of the server, as a newly-allocated string which must be freed by the caller. | |
void | dbus_server_set_new_connection_function (DBusServer *server, DBusNewConnectionFunction function, void *data, DBusFreeFunction free_data_function) |
Sets a function to be used for handling new connections. | |
dbus_bool_t | dbus_server_set_watch_functions (DBusServer *server, DBusAddWatchFunction add_function, DBusRemoveWatchFunction remove_function, DBusWatchToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function) |
Sets the watch functions for the connection. | |
dbus_bool_t | dbus_server_set_timeout_functions (DBusServer *server, DBusAddTimeoutFunction add_function, DBusRemoveTimeoutFunction remove_function, DBusTimeoutToggledFunction toggled_function, void *data, DBusFreeFunction free_data_function) |
Sets the timeout functions for the connection. | |
dbus_bool_t | dbus_server_set_auth_mechanisms (DBusServer *server, const char **mechanisms) |
Sets the authentication mechanisms that this server offers to clients, as a list of SASL mechanisms. | |
dbus_bool_t | dbus_server_allocate_data_slot (dbus_int32_t *slot_p) |
Allocates an integer ID to be used for storing application-specific data on any DBusServer. | |
void | dbus_server_free_data_slot (dbus_int32_t *slot_p) |
Deallocates a global ID for server data slots. | |
dbus_bool_t | dbus_server_set_data (DBusServer *server, int slot, void *data, DBusFreeFunction free_data_func) |
Stores a pointer on a DBusServer, along with an optional function to be used for freeing the data when the data is set again, or when the server is finalized. | |
void * | dbus_server_get_data (DBusServer *server, int slot) |
Retrieves data previously set with dbus_server_set_data(). |
Types and functions related to DBusServer. A DBusServer represents a server that other applications can connect to. Each connection from another application is represented by a DBusConnection.
Need notification to apps of disconnection, may matter for some transports
An opaque object representing a server that listens for connections from other applications.
Each time a connection is made, a new DBusConnection is created and made available via an application-provided DBusNewConnectionFunction. The DBusNewConnectionFunction is provided with dbus_server_set_new_connection_function().
Definition at line 37 of file dbus-server.h.
void _dbus_server_ref_unlocked | ( | DBusServer * | server | ) |
Like dbus_server_ref() but does not acquire the lock (must already be held).
server | the server. |
Definition at line 728 of file dbus-server.c.
References _dbus_assert, _dbus_atomic_inc(), NULL, refcount, and DBusAtomic::value.
Referenced by dbus_server_disconnect().
void _dbus_server_unref_unlocked | ( | DBusServer * | server | ) |
Like dbus_server_unref() but does not acquire the lock (must already be held).
server | the server. |
Definition at line 750 of file dbus-server.c.
References _dbus_assert, _dbus_atomic_dec(), disconnected, DBusServerVTable::finalize, NULL, refcount, DBusAtomic::value, and vtable.
dbus_bool_t dbus_server_allocate_data_slot | ( | dbus_int32_t * | slot_p | ) |
Allocates an integer ID to be used for storing application-specific data on any DBusServer.
The allocated ID may then be used with dbus_server_set_data() and dbus_server_get_data(). The slot must be initialized with -1. If a nonnegative slot is passed in, the refcount is incremented on that slot, rather than creating a new slot.
The allocated slot is global, i.e. all DBusServer objects will have a slot with the given integer ID reserved.
slot_p | address of global variable storing the slot ID |
Definition at line 1050 of file dbus-server.c.
References _dbus_data_slot_allocator_alloc(), and _DBUS_LOCK_NAME.
void dbus_server_disconnect | ( | DBusServer * | server | ) |
Releases the server's address and stops listening for new clients.
If called more than once, only the first call has an effect. Does not modify the server's reference count.
server | the server. |
Definition at line 789 of file dbus-server.c.
References _dbus_assert, _dbus_server_ref_unlocked(), dbus_server_unref(), DBusServerVTable::disconnect, disconnected, NULL, refcount, TRUE, DBusAtomic::value, and vtable.
void dbus_server_free_data_slot | ( | dbus_int32_t * | slot_p | ) |
Deallocates a global ID for server data slots.
dbus_server_get_data() and dbus_server_set_data() may no longer be used with this slot. Existing data stored on existing DBusServer objects will be freed when the server is finalized, but may not be retrieved (and may only be replaced if someone else reallocates the slot).
slot_p | address of the slot to deallocate |
Definition at line 1069 of file dbus-server.c.
References _dbus_data_slot_allocator_free().
char* dbus_server_get_address | ( | DBusServer * | server | ) |
Returns the address of the server, as a newly-allocated string which must be freed by the caller.
server | the server |
Definition at line 838 of file dbus-server.c.
References _dbus_strdup(), address, and NULL.
void* dbus_server_get_data | ( | DBusServer * | server, | |
int | slot | |||
) |
Retrieves data previously set with dbus_server_set_data().
The slot must still be allocated (must not have been freed).
server | the server | |
slot | the slot to get data from |
Definition at line 1130 of file dbus-server.c.
References _dbus_data_slot_list_get(), NULL, and slot_list.
dbus_bool_t dbus_server_get_is_connected | ( | DBusServer * | server | ) |
Returns TRUE if the server is still listening for new connections.
server | the server. |
Definition at line 817 of file dbus-server.c.
References disconnected, FALSE, and NULL.
DBusServer* dbus_server_listen | ( | const char * | address, | |
DBusError * | error | |||
) |
Listens for new connections on the given address.
Returns NULL if listening fails for any reason. Otherwise returns a new DBusServer. dbus_server_set_new_connection_function() and dbus_server_set_watch_functions() should be called immediately to render the server fully functional.
address | the address of this server. | |
error | location to store rationale for failure. |
Definition at line 483 of file dbus-server.c.
References _dbus_concat_dir_and_file(), _dbus_generate_random_ascii(), _dbus_server_new_for_domain_socket(), _dbus_server_new_for_tcp_socket(), _dbus_string_append(), _dbus_string_free(), _dbus_string_init(), _dbus_string_init_const(), _dbus_string_parse_int(), dbus_address_entries_free(), dbus_address_entry_get_method(), dbus_address_entry_get_value(), DBUS_ERROR_BAD_ADDRESS, DBUS_ERROR_NO_MEMORY, dbus_parse_address(), dbus_set_error(), FALSE, NULL, and TRUE.
DBusServer* dbus_server_ref | ( | DBusServer * | server | ) |
Increments the reference count of a DBusServer.
server | the server. |
Definition at line 664 of file dbus-server.c.
References _dbus_assert, _dbus_atomic_inc(), NULL, refcount, and DBusAtomic::value.
dbus_bool_t dbus_server_set_auth_mechanisms | ( | DBusServer * | server, | |
const char ** | mechanisms | |||
) |
Sets the authentication mechanisms that this server offers to clients, as a list of SASL mechanisms.
This function only affects connections created *after* it is called. Pass NULL instead of an array to use all available mechanisms.
server | the server | |
mechanisms | NULL-terminated array of mechanisms |
Definition at line 1005 of file dbus-server.c.
References _dbus_dup_string_array(), auth_mechanisms, dbus_free_string_array(), FALSE, NULL, and TRUE.
dbus_bool_t dbus_server_set_data | ( | DBusServer * | server, | |
int | slot, | |||
void * | data, | |||
DBusFreeFunction | free_data_func | |||
) |
Stores a pointer on a DBusServer, along with an optional function to be used for freeing the data when the data is set again, or when the server is finalized.
The slot number must have been allocated with dbus_server_allocate_data_slot().
server | the server | |
slot | the slot number | |
data | the data to store | |
free_data_func | finalizer function for the data |
Definition at line 1090 of file dbus-server.c.
References _dbus_data_slot_list_set(), FALSE, NULL, and slot_list.
void dbus_server_set_new_connection_function | ( | DBusServer * | server, | |
DBusNewConnectionFunction | function, | |||
void * | data, | |||
DBusFreeFunction | free_data_function | |||
) |
Sets a function to be used for handling new connections.
The given function is passed each new connection as the connection is created. If the new connection function increments the connection's reference count, the connection will stay alive. Otherwise, the connection will be unreferenced and closed.
server | the server. | |
function | a function to handle new connections. | |
data | data to pass to the new connection handler. | |
free_data_function | function to free the data. |
Definition at line 864 of file dbus-server.c.
References new_connection_data, new_connection_free_data_function, new_connection_function, and NULL.
Referenced by _dbus_server_finalize_base().
dbus_bool_t dbus_server_set_timeout_functions | ( | DBusServer * | server, | |
DBusAddTimeoutFunction | add_function, | |||
DBusRemoveTimeoutFunction | remove_function, | |||
DBusTimeoutToggledFunction | toggled_function, | |||
void * | data, | |||
DBusFreeFunction | free_data_function | |||
) |
Sets the timeout functions for the connection.
These functions are responsible for making the application's main loop aware of timeouts.
This function behaves exactly like dbus_connection_set_timeout_functions(); see the documentation for that routine.
server | the server. | |
add_function | function to add a timeout. | |
remove_function | function to remove a timeout. | |
toggled_function | function to notify when the timeout is enabled/disabled | |
data | data to pass to add_function and remove_function. | |
free_data_function | function to be called to free the data. |
Definition at line 957 of file dbus-server.c.
References _dbus_timeout_list_set_functions(), _dbus_warn(), FALSE, NULL, and timeouts.
dbus_bool_t dbus_server_set_watch_functions | ( | DBusServer * | server, | |
DBusAddWatchFunction | add_function, | |||
DBusRemoveWatchFunction | remove_function, | |||
DBusWatchToggledFunction | toggled_function, | |||
void * | data, | |||
DBusFreeFunction | free_data_function | |||
) |
Sets the watch functions for the connection.
These functions are responsible for making the application's main loop aware of file descriptors that need to be monitored for events.
This function behaves exactly like dbus_connection_set_watch_functions(); see the documentation for that routine.
server | the server. | |
add_function | function to begin monitoring a new descriptor. | |
remove_function | function to stop monitoring a descriptor. | |
toggled_function | function to notify when the watch is enabled/disabled | |
data | data to pass to add_function and remove_function. | |
free_data_function | function to be called to free the data. |
Definition at line 904 of file dbus-server.c.
References _dbus_warn(), _dbus_watch_list_set_functions(), FALSE, NULL, and watches.
void dbus_server_unref | ( | DBusServer * | server | ) |
Decrements the reference count of a DBusServer.
Finalizes the server if the reference count reaches zero.
The server must be disconnected before the refcount reaches zero.
server | the server. |
Definition at line 691 of file dbus-server.c.
References _dbus_assert, _dbus_atomic_dec(), disconnected, DBusServerVTable::finalize, NULL, refcount, DBusAtomic::value, and vtable.
Referenced by dbus_server_disconnect().