Add IgnoreOnIsolate=yes to dbus.service
[platform/upstream/dbus.git] / dbus / dbus-server-protected.h
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2 /* dbus-server-protected.h Used by subclasses of DBusServer object (internal to D-Bus implementation)
3  *
4  * Copyright (C) 2002  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 #ifndef DBUS_SERVER_PROTECTED_H
24 #define DBUS_SERVER_PROTECTED_H
25
26 #include <dbus/dbus-internals.h>
27 #include <dbus/dbus-threads-internal.h>
28 #include <dbus/dbus-server.h>
29 #include <dbus/dbus-address.h>
30 #include <dbus/dbus-timeout.h>
31 #include <dbus/dbus-watch.h>
32 #include <dbus/dbus-resources.h>
33 #include <dbus/dbus-dataslot.h>
34 #include <dbus/dbus-string.h>
35
36 DBUS_BEGIN_DECLS
37
38 typedef struct DBusServerVTable DBusServerVTable;
39
40 /**
41  * Virtual table to be implemented by all server "subclasses"
42  */
43 struct DBusServerVTable
44 {
45   void        (* finalize)      (DBusServer *server);
46   /**< The finalize method must free the server. */
47   
48   void        (* disconnect)    (DBusServer *server);
49   /**< Disconnect this server. */
50 };
51
52 /**
53  * @ingroup DBusServerInternals
54  * Internals of DBusServer object
55  */
56 struct DBusServer
57 {
58   DBusAtomic refcount;                        /**< Reference count. */
59   const DBusServerVTable *vtable;             /**< Virtual methods for this instance. */
60   DBusRMutex *mutex;                          /**< Lock on the server object */
61
62   DBusGUID guid;                              /**< Globally unique ID of server */
63
64   DBusString guid_hex;                        /**< Hex-encoded version of GUID */
65   
66   DBusWatchList *watches;                     /**< Our watches */
67   DBusTimeoutList *timeouts;                  /**< Our timeouts */  
68
69   char *address;                              /**< Address this server is listening on. */
70   dbus_bool_t published_address;              /**< flag which indicates that server has published its bus address. */
71
72   int max_connections;                        /**< Max number of connections allowed at once. */
73
74   DBusDataSlotList slot_list;   /**< Data stored by allocated integer ID */
75   
76   DBusNewConnectionFunction  new_connection_function;
77   /**< Callback to invoke when a new connection is created. */
78   void *new_connection_data;
79   /**< Data for new connection callback */
80   DBusFreeFunction new_connection_free_data_function;
81   /**< Callback to invoke to free new_connection_data
82    * when server is finalized or data is replaced.
83    */
84
85   char **auth_mechanisms; /**< Array of allowed authentication mechanisms */
86   
87   unsigned int disconnected : 1;              /**< TRUE if we are disconnected. */
88
89 #ifndef DBUS_DISABLE_CHECKS
90   unsigned int have_server_lock : 1; /**< Does someone have the server mutex locked */
91 #endif
92 };
93
94 dbus_bool_t _dbus_server_init_base      (DBusServer             *server,
95                                          const DBusServerVTable *vtable,
96                                          const DBusString       *address,
97                                          DBusError              *error);
98 void        _dbus_server_finalize_base  (DBusServer             *server);
99 void        _dbus_server_disconnect_unlocked (DBusServer        *server);
100 dbus_bool_t _dbus_server_add_watch      (DBusServer             *server,
101                                          DBusWatch              *watch);
102 void        _dbus_server_remove_watch   (DBusServer             *server,
103                                          DBusWatch              *watch);
104 DBUS_PRIVATE_EXPORT
105 void        _dbus_server_toggle_all_watches (DBusServer         *server,
106                                              dbus_bool_t         enabled);
107 dbus_bool_t _dbus_server_add_timeout    (DBusServer             *server,
108                                          DBusTimeout            *timeout);
109 void        _dbus_server_remove_timeout (DBusServer             *server,
110                                          DBusTimeout            *timeout);
111 void        _dbus_server_toggle_timeout (DBusServer             *server,
112                                          DBusTimeout            *timeout,
113                                          dbus_bool_t             enabled);
114
115 DBUS_PRIVATE_EXPORT
116 void        _dbus_server_ref_unlocked   (DBusServer             *server);
117 DBUS_PRIVATE_EXPORT
118 void        _dbus_server_unref_unlocked (DBusServer             *server);
119
120 typedef enum
121 {
122   DBUS_SERVER_LISTEN_NOT_HANDLED, /**< we aren't in charge of this address type */
123   DBUS_SERVER_LISTEN_OK,          /**< we set up the listen */
124   DBUS_SERVER_LISTEN_BAD_ADDRESS, /**< malformed address */
125   DBUS_SERVER_LISTEN_DID_NOT_CONNECT, /**< well-formed address but failed to set it up */
126   DBUS_SERVER_LISTEN_ADDRESS_ALREADY_USED /**< address is already used */
127 } DBusServerListenResult;
128
129 DBusServerListenResult _dbus_server_listen_platform_specific (DBusAddressEntry  *entry,
130                                                               DBusServer       **server_p,
131                                                               DBusError         *error);
132
133 #ifdef DBUS_ENABLE_VERBOSE_MODE
134 void _dbus_server_trace_ref (DBusServer *server,
135     int old_refcount,
136     int new_refcount,
137     const char *why);
138 #else
139 #define _dbus_server_trace_ref(s,o,n,w) \
140   do \
141   {\
142     (void) (o); \
143     (void) (n); \
144   } while (0)
145 #endif
146
147 #ifdef DBUS_DISABLE_CHECKS
148 #define TOOK_LOCK_CHECK(server)
149 #define RELEASING_LOCK_CHECK(server)
150 #define HAVE_LOCK_CHECK(server)
151 #else
152 #define TOOK_LOCK_CHECK(server) do {                \
153     _dbus_assert (!(server)->have_server_lock); \
154     (server)->have_server_lock = TRUE;          \
155   } while (0)
156 #define RELEASING_LOCK_CHECK(server) do {            \
157     _dbus_assert ((server)->have_server_lock);   \
158     (server)->have_server_lock = FALSE;          \
159   } while (0)
160 #define HAVE_LOCK_CHECK(server)        _dbus_assert ((server)->have_server_lock)
161 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
162 #endif
163
164 #define TRACE_LOCKS 0
165
166 #define SERVER_LOCK(server)   do {                                              \
167     if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); }   \
168     _dbus_rmutex_lock ((server)->mutex);                                        \
169     TOOK_LOCK_CHECK (server);                                                   \
170   } while (0)
171
172 #define SERVER_UNLOCK(server) do {                                                      \
173     if (TRACE_LOCKS) { _dbus_verbose ("UNLOCK\n");  }        \
174     RELEASING_LOCK_CHECK (server);                                                      \
175     _dbus_rmutex_unlock ((server)->mutex);                                              \
176   } while (0)
177
178 DBUS_END_DECLS
179
180 #endif /* DBUS_SERVER_PROTECTED_H */