dbus/dbus-server-protected.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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-server.h>
  28 #include <dbus/dbus-timeout.h>
  29 #include <dbus/dbus-watch.h>
  30 #include <dbus/dbus-resources.h>
  31 #include <dbus/dbus-dataslot.h>
  32
  33 DBUS_BEGIN_DECLS
  34
  35 typedef struct DBusServerVTable DBusServerVTable;
  36
  37 /**
  38  * Virtual table to be implemented by all server "subclasses"
  39  */
  40 struct DBusServerVTable
  41 {
  42   void        (* finalize)      (DBusServer *server);
  43   /**< The finalize method must free the server. */
  44
  45   void        (* disconnect)    (DBusServer *server);
  46   /**< Disconnect this server. */
  47 };
  48
  49 /**
  50  * Internals of DBusServer object
  51  */
  52 struct DBusServer
  53 {
  54   int refcount;                               /**< Reference count. */
  55   const DBusServerVTable *vtable;             /**< Virtual methods for this instance. */
  56   DBusWatchList *watches;                     /**< Our watches */
  57   DBusTimeoutList *timeouts;                  /**< Our timeouts */
  58
  59   char *address;                              /**< Address this server is listening on. */
  60
  61   int max_connections;                        /**< Max number of connections allowed at once. */
  62
  63   DBusDataSlotList slot_list;   /**< Data stored by allocated integer ID */
  64
  65   DBusNewConnectionFunction  new_connection_function;
  66   /**< Callback to invoke when a new connection is created. */
  67   void *new_connection_data;
  68   /**< Data for new connection callback */
  69   DBusFreeFunction new_connection_free_data_function;
  70   /**< Callback to invoke to free new_connection_data
  71    * when server is finalized or data is replaced.
  72    */
  73
  74   char **auth_mechanisms; /**< Array of allowed authentication mechanisms */
  75
  76   unsigned int disconnected : 1;              /**< TRUE if we are disconnected. */
  77 };
  78
  79 dbus_bool_t _dbus_server_init_base      (DBusServer             *server,
  80                                          const DBusServerVTable *vtable,
  81                                          const DBusString       *address);
  82 void        _dbus_server_finalize_base  (DBusServer             *server);
  83 dbus_bool_t _dbus_server_add_watch      (DBusServer             *server,
  84                                          DBusWatch              *watch);
  85 void        _dbus_server_remove_watch   (DBusServer             *server,
  86                                          DBusWatch              *watch);
  87 void        _dbus_server_toggle_watch   (DBusServer             *server,
  88                                          DBusWatch              *watch,
  89                                          dbus_bool_t             enabled);
  90 dbus_bool_t _dbus_server_add_timeout    (DBusServer             *server,
  91                                          DBusTimeout            *timeout);
  92 void        _dbus_server_remove_timeout (DBusServer             *server,
  93                                          DBusTimeout            *timeout);
  94 void        _dbus_server_toggle_timeout (DBusServer             *server,
  95                                          DBusTimeout            *timeout,
  96                                          dbus_bool_t             enabled);
  97
  98
  99
 100 DBUS_END_DECLS
 101
 102 #endif /* DBUS_SERVER_PROTECTED_H */