D-Bus 1.13.18

dbus-server.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-server.h DBusServer object
3 *
4 * Copyright (C) 2002, 2003 Red Hat Inc.
5 *
6 * Licensed under the Academic Free License version 2.1
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
24#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
25#endif
26
27#ifndef DBUS_SERVER_H
28#define DBUS_SERVER_H
29
30#include <dbus/dbus-errors.h>
31#include <dbus/dbus-macros.h>
32#include <dbus/dbus-message.h>
33#include <dbus/dbus-connection.h>
34#include <dbus/dbus-protocol.h>
35
36 DBUS_BEGIN_DECLS
37
43 typedef struct DBusServer DBusServer;
44
48 typedef void (* DBusNewConnectionFunction) (DBusServer *server,
49 DBusConnection *new_connection,
50 void *data);
51
52DBUS_EXPORT
53 DBusServer* dbus_server_listen (const char *address,
54 DBusError *error);
55DBUS_EXPORT
56 DBusServer* dbus_server_ref (DBusServer *server);
57DBUS_EXPORT
58 void dbus_server_unref (DBusServer *server);
59DBUS_EXPORT
60 void dbus_server_disconnect (DBusServer *server);
61DBUS_EXPORT
62 dbus_bool_t dbus_server_get_is_connected (DBusServer *server);
63DBUS_EXPORT
64 char* dbus_server_get_address (DBusServer *server);
65DBUS_EXPORT
66 char* dbus_server_get_id (DBusServer *server);
67DBUS_EXPORT
68 void dbus_server_set_new_connection_function (DBusServer *server,
69 DBusNewConnectionFunction function,
70 void *data,
71 DBusFreeFunction free_data_function);
72DBUS_EXPORT
73 dbus_bool_t dbus_server_set_watch_functions (DBusServer *server,
74 DBusAddWatchFunction add_function,
75 DBusRemoveWatchFunction remove_function,
76 DBusWatchToggledFunction toggled_function,
77 void *data,
78 DBusFreeFunction free_data_function);
79DBUS_EXPORT
80 dbus_bool_t dbus_server_set_timeout_functions (DBusServer *server,
81 DBusAddTimeoutFunction add_function,
82 DBusRemoveTimeoutFunction remove_function,
83 DBusTimeoutToggledFunction toggled_function,
84 void *data,
85 DBusFreeFunction free_data_function);
86DBUS_EXPORT
87 dbus_bool_t dbus_server_set_auth_mechanisms (DBusServer *server,
88 const char **mechanisms);
89
90DBUS_EXPORT
91 dbus_bool_t dbus_server_allocate_data_slot (dbus_int32_t *slot_p);
92DBUS_EXPORT
93 void dbus_server_free_data_slot (dbus_int32_t *slot_p);
94DBUS_EXPORT
95 dbus_bool_t dbus_server_set_data (DBusServer *server,
96 int slot,
97 void *data,
98 DBusFreeFunction free_data_func);
99DBUS_EXPORT
100 void* dbus_server_get_data (DBusServer *server,
101 int slot);
102
115 static inline void
116dbus_clear_server (DBusServer **pointer_to_server)
117{
118 _dbus_clear_pointer_impl (DBusServer, pointer_to_server, dbus_server_unref);
119}
120
123 DBUS_END_DECLS
124
125#endif /* DBUS_SERVER_H */
DBusWatchToggledFunction
void(* DBusWatchToggledFunction)(DBusWatch *watch, void *data)
Called when dbus_watch_get_enabled() may return a different value than it did before.
Definition: dbus-connection.h:98
DBusAddWatchFunction
dbus_bool_t(* DBusAddWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus needs a new watch to be monitored by the main loop.
Definition: dbus-connection.h:92
DBusTimeoutToggledFunction
void(* DBusTimeoutToggledFunction)(DBusTimeout *timeout, void *data)
Called when dbus_timeout_get_enabled() may return a different value than it did before.
Definition: dbus-connection.h:118
DBusAddTimeoutFunction
dbus_bool_t(* DBusAddTimeoutFunction)(DBusTimeout *timeout, void *data)
Called when libdbus needs a new timeout to be monitored by the main loop.
Definition: dbus-connection.h:111
DBusRemoveWatchFunction
void(* DBusRemoveWatchFunction)(DBusWatch *watch, void *data)
Called when libdbus no longer needs a watch to be monitored by the main loop.
Definition: dbus-connection.h:104
DBusRemoveTimeoutFunction
void(* DBusRemoveTimeoutFunction)(DBusTimeout *timeout, void *data)
Called when libdbus no longer needs a timeout to be monitored by the main loop.
Definition: dbus-connection.h:124
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
DBusFreeFunction
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:63
dbus_server_allocate_data_slot
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.
Definition: dbus-server.c:1098
dbus_server_disconnect
void dbus_server_disconnect(DBusServer *server)
Releases the server's address and stops listening for new clients.
Definition: dbus-server.c:796
dbus_server_set_auth_mechanisms
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 ...
Definition: dbus-server.c:1051
dbus_server_get_id
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.
Definition: dbus-server.c:872
dbus_server_listen
DBusServer * dbus_server_listen(const char *address, DBusError *error)
Listens for new connections on the given address.
Definition: dbus-server.c:557
dbus_server_get_address
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.
Definition: dbus-server.c:836
dbus_server_get_is_connected
dbus_bool_t dbus_server_get_is_connected(DBusServer *server)
Returns TRUE if the server is still listening for new connections.
Definition: dbus-server.c:815
dbus_server_unref
void dbus_server_unref(DBusServer *server)
Decrements the reference count of a DBusServer.
Definition: dbus-server.c:733
dbus_server_set_new_connection_function
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.
Definition: dbus-server.c:907
dbus_server_set_watch_functions
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.
Definition: dbus-server.c:947
dbus_server_set_data
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 whe...
Definition: dbus-server.c:1137
dbus_server_ref
DBusServer * dbus_server_ref(DBusServer *server)
Increments the reference count of a DBusServer.
Definition: dbus-server.c:701
dbus_server_get_data
void * dbus_server_get_data(DBusServer *server, int slot)
Retrieves data previously set with dbus_server_set_data().
Definition: dbus-server.c:1177
dbus_server_free_data_slot
void dbus_server_free_data_slot(dbus_int32_t *slot_p)
Deallocates a global ID for server data slots.
Definition: dbus-server.c:1116
dbus_server_set_timeout_functions
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.
Definition: dbus-server.c:1000
DBusNewConnectionFunction
void(* DBusNewConnectionFunction)(DBusServer *server, DBusConnection *new_connection, void *data)
Called when a new connection to the server is available.
Definition: dbus-server.h:48
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusConnection
Implementation details of DBusConnection.
Definition: dbus-connection.c:257
DBusError
Object representing an exception.
Definition: dbus-errors.h:49
DBusServer
Internals of DBusServer object.
Definition: dbus-server-protected.h:57
DBusServer::address
char * address
Address this server is listening on.
Definition: dbus-server-protected.h:69