dbus/dbus-transport-protected.h

   1 /* -*- mode: C; c-file-style: "gnu" -*- */
   2 /* dbus-transport-protected.h Used by subclasses of DBusTransport 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_TRANSPORT_PROTECTED_H
  24 #define DBUS_TRANSPORT_PROTECTED_H
  25
  26 #include <dbus/dbus-internals.h>
  27 #include <dbus/dbus-errors.h>
  28 #include <dbus/dbus-transport.h>
  29 #include <dbus/dbus-message-internal.h>
  30 #include <dbus/dbus-auth.h>
  31 #include <dbus/dbus-resources.h>
  32
  33 DBUS_BEGIN_DECLS;
  34
  35 typedef struct DBusTransportVTable DBusTransportVTable;
  36
  37 struct DBusTransportVTable
  38 {
  39   void (* finalize)           (DBusTransport *transport);
  40   /**< The finalize method must free the transport. */
  41
  42   void (* handle_watch)       (DBusTransport *transport,
  43                                DBusWatch     *watch,
  44                                unsigned int   flags);
  45   /**< The handle_watch method handles reading/writing
  46    * data as indicated by the flags.
  47    */
  48
  49   void (* disconnect)         (DBusTransport *transport);
  50   /**< Disconnect this transport. */
  51
  52   dbus_bool_t (* connection_set)     (DBusTransport *transport);
  53   /**< Called when transport->connection has been filled in */
  54
  55   void (* messages_pending)   (DBusTransport *transport,
  56                                int            queue_length);
  57   /**< Called when the outgoing message queue goes from empty
  58    * to non-empty or vice versa.
  59    */
  60
  61   void (* do_iteration)       (DBusTransport *transport,
  62                                unsigned int   flags,
  63                                int            timeout_milliseconds);
  64   /**< Called to do a single "iteration" (block on select/poll
  65    * followed by reading or writing data).
  66    */
  67
  68   void (* live_messages_changed) (DBusTransport *transport);
  69   /**< Outstanding messages counter changed */
  70 };
  71
  72 struct DBusTransport
  73 {
  74   int refcount;                               /**< Reference count. */
  75
  76   const DBusTransportVTable *vtable;          /**< Virtual methods for this instance. */
  77
  78   DBusConnection *connection;                 /**< Connection owning this transport. */
  79
  80   DBusMessageLoader *loader;                  /**< Message-loading buffer. */
  81
  82   DBusAuth *auth;                             /**< Authentication conversation */
  83
  84   DBusCredentials credentials;                /**< Credentials of other end */
  85
  86   long max_live_messages_size;                /**< Max total size of received messages. */
  87
  88   DBusCounter *live_messages_size;            /**< Counter for size of all live messages. */
  89
  90   unsigned int disconnected : 1;              /**< #TRUE if we are disconnected. */
  91   unsigned int authenticated : 1;             /**< Cache of auth state; use _dbus_transport_get_is_authenticated() to query value */
  92   unsigned int messages_need_sending : 1;     /**< #TRUE if we need to write messages out */
  93   unsigned int send_credentials_pending : 1;  /**< #TRUE if we need to send credentials */
  94   unsigned int receive_credentials_pending : 1; /**< #TRUE if we need to receive credentials */
  95   unsigned int is_server : 1;                 /**< #TRUE if on the server side */
  96 };
  97
  98 dbus_bool_t _dbus_transport_init_base     (DBusTransport             *transport,
  99                                            const DBusTransportVTable *vtable,
 100                                            dbus_bool_t                server);
 101 void        _dbus_transport_finalize_base (DBusTransport             *transport);
 102
 103
 104
 105 DBUS_END_DECLS;
 106
 107 #endif /* DBUS_TRANSPORT_PROTECTED_H */