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 1.2
   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-watch.h>
  29 #include <dbus/dbus-resources.h>
  30
  31 DBUS_BEGIN_DECLS;
  32
  33 typedef struct DBusServerVTable DBusServerVTable;
  34
  35 struct DBusServerVTable
  36 {
  37   void (* finalize)      (DBusServer *server);
  38   /**< The finalize method must free the server. */
  39
  40   void (* handle_watch)  (DBusServer  *server,
  41                           DBusWatch   *watch,
  42                           unsigned int flags);
  43   /**< The handle_watch method handles reading/writing
  44    * data as indicated by the flags.
  45    */
  46
  47   void (* disconnect)    (DBusServer *server);
  48   /**< Disconnect this server. */
  49 };
  50
  51 struct DBusServer
  52 {
  53   int refcount;                               /**< Reference count. */
  54   const DBusServerVTable *vtable;             /**< Virtual methods for this instance. */
  55   DBusWatchList *watches;                     /**< Our watches */
  56
  57   DBusCounter *connection_counter;            /**< Number of non-finalized DBusConnection
  58                                                *   to this server
  59                                                */
  60
  61   int max_connections;                        /**< Max number of connections allowed at once. */
  62
  63   DBusNewConnectionFunction  new_connection_function;
  64   /**< Callback to invoke when a new connection is created. */
  65   void *new_connection_data;
  66   /**< Data for new connection callback */
  67   DBusFreeFunction new_connection_free_data_function;
  68   /**< Callback to invoke to free new_connection_data
  69    * when server is finalized or data is replaced.
  70    */
  71
  72   unsigned int disconnected : 1;              /**< TRUE if we are disconnected. */
  73 };
  74
  75 dbus_bool_t  _dbus_server_init_base     (DBusServer             *server,
  76                                         const DBusServerVTable *vtable);
  77 void        _dbus_server_finalize_base (DBusServer             *server);
  78 dbus_bool_t _dbus_server_add_watch     (DBusServer             *server,
  79                                         DBusWatch              *watch);
  80 void        _dbus_server_remove_watch  (DBusServer             *server,
  81                                         DBusWatch              *watch);
  82
  83
  84 DBUS_END_DECLS;
  85
  86 #endif /* DBUS_SERVER_PROTECTED_H */