D-Bus  1.6.8
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 
37 
38 typedef struct DBusServerVTable DBusServerVTable;
39 
44 {
45  void (* finalize) (DBusServer *server);
48  void (* disconnect) (DBusServer *server);
50 };
51 
56 struct DBusServer
57 {
69  char *address;
78  void *new_connection_data;
85  char **auth_mechanisms;
87  unsigned int disconnected : 1;
89 #ifndef DBUS_DISABLE_CHECKS
90  unsigned int have_server_lock : 1;
91 #endif
92 };
93 
95  const DBusServerVTable *vtable,
96  const DBusString *address);
99  DBusWatch *watch);
101  DBusWatch *watch);
103  dbus_bool_t enabled);
105  DBusTimeout *timeout);
107  DBusTimeout *timeout);
109  DBusTimeout *timeout,
110  dbus_bool_t enabled);
111 
114 
115 typedef enum
116 {
117  DBUS_SERVER_LISTEN_NOT_HANDLED,
118  DBUS_SERVER_LISTEN_OK,
119  DBUS_SERVER_LISTEN_BAD_ADDRESS,
120  DBUS_SERVER_LISTEN_DID_NOT_CONNECT,
121  DBUS_SERVER_LISTEN_ADDRESS_ALREADY_USED
122 } DBusServerListenResult;
123 
124 DBusServerListenResult _dbus_server_listen_platform_specific (DBusAddressEntry *entry,
125  DBusServer **server_p,
126  DBusError *error);
127 
128 #ifdef DBUS_ENABLE_VERBOSE_MODE
129 void _dbus_server_trace_ref (DBusServer *server,
130  int old_refcount,
131  int new_refcount,
132  const char *why);
133 #else
134 #define _dbus_server_trace_ref(s,o,n,w) \
135  do \
136  {\
137  (void) (o); \
138  (void) (n); \
139  } while (0)
140 #endif
141 
142 #ifdef DBUS_DISABLE_CHECKS
143 #define TOOK_LOCK_CHECK(server)
144 #define RELEASING_LOCK_CHECK(server)
145 #define HAVE_LOCK_CHECK(server)
146 #else
147 #define TOOK_LOCK_CHECK(server) do { \
148  _dbus_assert (!(server)->have_server_lock); \
149  (server)->have_server_lock = TRUE; \
150  } while (0)
151 #define RELEASING_LOCK_CHECK(server) do { \
152  _dbus_assert ((server)->have_server_lock); \
153  (server)->have_server_lock = FALSE; \
154  } while (0)
155 #define HAVE_LOCK_CHECK(server) _dbus_assert ((server)->have_server_lock)
156 /* A "DO_NOT_HAVE_LOCK_CHECK" is impossible since we need the lock to check the flag */
157 #endif
158 
159 #define TRACE_LOCKS 0
160 
161 #define SERVER_LOCK(server) do { \
162  if (TRACE_LOCKS) { _dbus_verbose ("LOCK\n"); } \
163  _dbus_rmutex_lock ((server)->mutex); \
164  TOOK_LOCK_CHECK (server); \
165  } while (0)
166 
167 #define SERVER_UNLOCK(server) do { \
168  if (TRACE_LOCKS) { _dbus_verbose ("UNLOCK\n"); } \
169  RELEASING_LOCK_CHECK (server); \
170  _dbus_rmutex_unlock ((server)->mutex); \
171  } while (0)
172 
174 
175 #endif /* DBUS_SERVER_PROTECTED_H */