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