• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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, 2004  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_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 /**
38  * The virtual table that must be implemented to
39  * create a new kind of transport.
40  */
41 struct DBusTransportVTable
42 {
43   void        (* finalize)              (DBusTransport *transport);
44   /**< The finalize method must free the transport. */
45 
46   dbus_bool_t (* handle_watch)          (DBusTransport *transport,
47                                          DBusWatch     *watch,
48                                          unsigned int   flags);
49   /**< The handle_watch method handles reading/writing
50    * data as indicated by the flags.
51    */
52 
53   void        (* disconnect)            (DBusTransport *transport);
54   /**< Disconnect this transport. */
55 
56   dbus_bool_t (* connection_set)        (DBusTransport *transport);
57   /**< Called when transport->connection has been filled in */
58 
59   void        (* do_iteration)          (DBusTransport *transport,
60                                          unsigned int   flags,
61                                          int            timeout_milliseconds);
62   /**< Called to do a single "iteration" (block on select/poll
63    * followed by reading or writing data).
64    */
65 
66   void        (* live_messages_changed) (DBusTransport *transport);
67   /**< Outstanding messages counter changed */
68 
69   dbus_bool_t (* get_socket_fd) (DBusTransport *transport,
70                                  int           *fd_p);
71   /**< Get socket file descriptor */
72 };
73 
74 /**
75  * Object representing a transport such as a socket.
76  * A transport can shuttle messages from point A to point B,
77  * and is the backend for a #DBusConnection.
78  *
79  */
80 struct DBusTransport
81 {
82   int refcount;                               /**< Reference count. */
83 
84   const DBusTransportVTable *vtable;          /**< Virtual methods for this instance. */
85 
86   DBusConnection *connection;                 /**< Connection owning this transport. */
87 
88   DBusMessageLoader *loader;                  /**< Message-loading buffer. */
89 
90   DBusAuth *auth;                             /**< Authentication conversation */
91 
92   DBusCredentials credentials;                /**< Credentials of other end */
93 
94   long max_live_messages_size;                /**< Max total size of received messages. */
95 
96   DBusCounter *live_messages_size;            /**< Counter for size of all live messages. */
97 
98 
99   char *address;                              /**< Address of the server we are connecting to (#NULL for the server side of a transport) */
100 
101   char *expected_guid;                        /**< GUID we expect the server to have, #NULL on server side or if we don't have an expectation */
102 
103   DBusAllowUnixUserFunction unix_user_function; /**< Function for checking whether a user is authorized. */
104   void *unix_user_data;                         /**< Data for unix_user_function */
105 
106   DBusFreeFunction free_unix_user_data;         /**< Function to free unix_user_data */
107 
108   unsigned int disconnected : 1;              /**< #TRUE if we are disconnected. */
109   unsigned int authenticated : 1;             /**< Cache of auth state; use _dbus_transport_get_is_authenticated() to query value */
110   unsigned int send_credentials_pending : 1;  /**< #TRUE if we need to send credentials */
111   unsigned int receive_credentials_pending : 1; /**< #TRUE if we need to receive credentials */
112   unsigned int is_server : 1;                 /**< #TRUE if on the server side */
113   unsigned int unused_bytes_recovered : 1;    /**< #TRUE if we've recovered unused bytes from auth */
114 };
115 
116 dbus_bool_t _dbus_transport_init_base     (DBusTransport             *transport,
117                                            const DBusTransportVTable *vtable,
118                                            const DBusString          *server_guid,
119                                            const DBusString          *address);
120 void        _dbus_transport_finalize_base (DBusTransport             *transport);
121 
122 
123 typedef enum
124 {
125   DBUS_TRANSPORT_OPEN_NOT_HANDLED,    /**< we aren't in charge of this address type */
126   DBUS_TRANSPORT_OPEN_OK,             /**< we set up the listen */
127   DBUS_TRANSPORT_OPEN_BAD_ADDRESS,    /**< malformed address */
128   DBUS_TRANSPORT_OPEN_DID_NOT_CONNECT /**< well-formed address but failed to set it up */
129 } DBusTransportOpenResult;
130 
131 DBusTransportOpenResult _dbus_transport_open_platform_specific (DBusAddressEntry  *entry,
132                                                                 DBusTransport    **transport_p,
133                                                                 DBusError         *error);
134 
135 DBUS_END_DECLS
136 
137 #endif /* DBUS_TRANSPORT_PROTECTED_H */
138