dbus-transport-protected.h 4.25 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/* -*- mode: C; c-file-style: "gnu" -*- */
/* dbus-transport-protected.h Used by subclasses of DBusTransport object (internal to D-BUS implementation)
 *
 * Copyright (C) 2002  Red Hat Inc.
 *
 * Licensed under the Academic Free License version 1.2
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#ifndef DBUS_TRANSPORT_PROTECTED_H
#define DBUS_TRANSPORT_PROTECTED_H

#include <dbus/dbus-internals.h>
#include <dbus/dbus-errors.h>
#include <dbus/dbus-transport.h>
#include <dbus/dbus-message-internal.h>
30
#include <dbus/dbus-auth.h>
31
#include <dbus/dbus-resources.h>
32 33 34 35 36 37 38

DBUS_BEGIN_DECLS;

typedef struct DBusTransportVTable DBusTransportVTable;

struct DBusTransportVTable
{
39
  void        (* finalize)              (DBusTransport *transport);
40 41
  /**< The finalize method must free the transport. */

42 43 44
  dbus_bool_t (* handle_watch)          (DBusTransport *transport,
                                         DBusWatch     *watch,
                                         unsigned int   flags);
45 46 47 48
  /**< The handle_watch method handles reading/writing
   * data as indicated by the flags.
   */

49
  void        (* disconnect)            (DBusTransport *transport);
50 51
  /**< Disconnect this transport. */

52
  dbus_bool_t (* connection_set)        (DBusTransport *transport);
53 54
  /**< Called when transport->connection has been filled in */

55 56
  void        (* messages_pending)      (DBusTransport *transport,
                                         int            queue_length);
57 58 59 60
  /**< Called when the outgoing message queue goes from empty
   * to non-empty or vice versa.
   */

61 62 63
  void        (* do_iteration)          (DBusTransport *transport,
                                         unsigned int   flags,
                                         int            timeout_milliseconds);
64 65 66
  /**< Called to do a single "iteration" (block on select/poll
   * followed by reading or writing data).
   */
67

68
  void        (* live_messages_changed) (DBusTransport *transport);
69
  /**< Outstanding messages counter changed */
70 71 72 73 74 75 76 77 78 79 80
};

struct DBusTransport
{
  int refcount;                               /**< Reference count. */

  const DBusTransportVTable *vtable;          /**< Virtual methods for this instance. */

  DBusConnection *connection;                 /**< Connection owning this transport. */

  DBusMessageLoader *loader;                  /**< Message-loading buffer. */
81 82 83

  DBusAuth *auth;                             /**< Authentication conversation */

84 85 86 87 88
  DBusCredentials credentials;                /**< Credentials of other end */  

  long max_live_messages_size;                /**< Max total size of received messages. */

  DBusCounter *live_messages_size;            /**< Counter for size of all live messages. */
89
  
90 91 92
  unsigned int disconnected : 1;              /**< #TRUE if we are disconnected. */
  unsigned int authenticated : 1;             /**< Cache of auth state; use _dbus_transport_get_is_authenticated() to query value */
  unsigned int messages_need_sending : 1;     /**< #TRUE if we need to write messages out */
93 94 95
  unsigned int send_credentials_pending : 1;  /**< #TRUE if we need to send credentials */
  unsigned int receive_credentials_pending : 1; /**< #TRUE if we need to receive credentials */
  unsigned int is_server : 1;                 /**< #TRUE if on the server side */
96 97 98
};

dbus_bool_t _dbus_transport_init_base     (DBusTransport             *transport,
99 100
                                           const DBusTransportVTable *vtable,
                                           dbus_bool_t                server);
101 102 103 104 105 106 107
void        _dbus_transport_finalize_base (DBusTransport             *transport);



DBUS_END_DECLS;

#endif /* DBUS_TRANSPORT_PROTECTED_H */