D-Bus: DBusServer

typedef void(* ) DBusNewConnectionFunction(DBusServer *server, DBusConnection *new_connection, void *data)

Called when a new connection to the server is available.

Must reference and save the new connection, or close the new connection. Set with dbus_server_set_new_connection_function().

Definition at line 47 of file dbus-server.h.

DBusServer

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 42 of file dbus-server.h.

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.

Parameters:

slot_p

address of global variable storing the slot ID

Returns:: FALSE on no memory

Definition at line 1046 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.

Parameters:

server

the server.

Definition at line 737 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).

Parameters:

slot_p

address of the slot to deallocate

Definition at line 1065 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.

Parameters:

server

the server

Returns:: the address or NULL if no memory

Definition at line 786 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).

Parameters:

	server	the server
	slot	the slot to get data from

Returns:: the data, or NULL if not found

Definition at line 1126 of file dbus-server.c.

References _dbus_data_slot_list_get(), NULL, and slot_list.

char * dbus_server_get_id ( DBusServer * server )

Returns the unique ID of the server, as a newly-allocated string which must be freed by the caller.

This ID is normally used by clients to tell when two DBusConnection would be equivalent (because the server address passed to dbus_connection_open() will have the same guid in the two cases). dbus_connection_open() can re-use an existing connection with the same ID instead of opening a new connection.

This is an ID unique to each DBusServer. Remember that a DBusServer represents only one mode of connecting, so e.g. a bus daemon can listen on multiple addresses which will mean it has multiple DBusServer each with their own ID.

The ID is not a UUID in the sense of RFC4122; the details are explained in the D-Bus specification.

Parameters:

server

the server

Returns:: the id of the server or NULL if no memory

Definition at line 822 of file dbus-server.c.

References _dbus_string_copy_data(), guid_hex, and NULL.

dbus_bool_t dbus_server_get_is_connected ( DBusServer * server )

Returns TRUE if the server is still listening for new connections.

Parameters:

server

the server.

Definition at line 765 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.

If there are multiple semicolon-separated address entries in the address, tries each one and listens on the first one that works.

Returns NULL and sets error if listening fails for any reason. Otherwise returns a new DBusServer. dbus_server_set_new_connection_function(), dbus_server_set_watch_functions(), and dbus_server_set_timeout_functions() should be called immediately to render the server fully functional.

To free the server, applications must call first dbus_server_disconnect() and then dbus_server_unref().

Parameters:

	address	the address of this server.
	error	location to store reason for failure.

Returns:: a new DBusServer, or NULL on failure.

Definition at line 540 of file dbus-server.c.

References _dbus_assert, _DBUS_N_ELEMENTS, dbus_address_entries_free(), dbus_address_entry_get_method(), DBUS_ERROR_BAD_ADDRESS, dbus_error_free(), DBUS_ERROR_INIT, dbus_error_is_set(), dbus_move_error(), dbus_parse_address(), dbus_set_error(), FALSE, NULL, and TRUE.

DBusServer * dbus_server_ref ( DBusServer * server )

Increments the reference count of a DBusServer.

Parameters:

server

the server.

Returns:: the server

Definition at line 668 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 NULL-terminated array of mechanism names.

This function only affects connections created after it is called. Pass NULL instead of an array to use all available mechanisms (this is the default behavior).

The D-Bus specification describes some of the supported mechanisms.

Parameters:

	server	the server
	mechanisms	NULL-terminated array of mechanisms

Returns:: FALSE if no memory

Definition at line 1001 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().

Parameters:

	server	the server
	slot	the slot number
	data	the data to store
	free_data_func	finalizer function for the data

Returns:: TRUE if there was enough memory to store the data

Definition at line 1086 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. The new connection function may also close the connection itself, which is considered good form if the connection is not wanted.

The connection here is private in the sense of dbus_connection_open_private(), so if the new connection function keeps a reference it must arrange for the connection to be closed. i.e. libdbus does not own this connection once the new connection function takes a reference.

Parameters:

	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 857 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 server.

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.

Parameters:

	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.

Returns:: FALSE on failure (no memory)

Definition at line 950 of file dbus-server.c.

References _dbus_timeout_list_set_functions(), _dbus_warn_check_failed(), 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 server.

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.

Parameters:

	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.

Returns:: FALSE on failure (no memory)

Definition at line 897 of file dbus-server.c.

References _dbus_warn_check_failed(), _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.

Parameters:

server

the server.

Definition at line 695 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().

DBusServer
[D-Bus low-level public API]

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation


Typedefs
typedef DBusServer	DBusServer
	An opaque object representing a server that listens for connections from other applications.
typedef void(*)	DBusNewConnectionFunction (DBusServer server, DBusConnection new_connection, void *data)
	Called when a new connection to the server is available.
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_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.
char *	dbus_server_get_id (DBusServer *server)
	Returns the unique ID 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 server.
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 server.
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 NULL-terminated array of mechanism names.
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().

DBusServer [D-Bus low-level public API]

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation

DBusServer
[D-Bus low-level public API]