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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/* -*- 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 2.1
*
* 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>
#include <dbus/dbus-auth.h>
#include <dbus/dbus-resources.h>
DBUS_BEGIN_DECLS;
typedef struct DBusTransportVTable DBusTransportVTable;
/**
* The virtual table that must be implemented to
* create a new kind of transport.
*/
struct DBusTransportVTable
{
void (* finalize) (DBusTransport *transport);
/**< The finalize method must free the transport. */
dbus_bool_t (* handle_watch) (DBusTransport *transport,
DBusWatch *watch,
unsigned int flags);
/**< The handle_watch method handles reading/writing
* data as indicated by the flags.
*/
void (* disconnect) (DBusTransport *transport);
/**< Disconnect this transport. */
dbus_bool_t (* connection_set) (DBusTransport *transport);
/**< Called when transport->connection has been filled in */
void (* messages_pending) (DBusTransport *transport,
int queue_length);
/**< Called when the outgoing message queue goes from empty
* to non-empty or vice versa.
*/
void (* do_iteration) (DBusTransport *transport,
unsigned int flags,
int timeout_milliseconds);
/**< Called to do a single "iteration" (block on select/poll
* followed by reading or writing data).
*/
void (* live_messages_changed) (DBusTransport *transport);
/**< Outstanding messages counter changed */
dbus_bool_t (* get_unix_fd) (DBusTransport *transport,
int *fd_p);
/**< Get UNIX file descriptor */
};
/**
* Object representing a transport such as a socket.
* A transport can shuttle messages from point A to point B,
* and is the backend for a #DBusConnection.
*
*/
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. */
DBusAuth *auth; /**< Authentication conversation */
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. */
char *address; /**< Address of this server */
DBusAllowUnixUserFunction unix_user_function; /**< Function for checking whether a user is authorized. */
void *unix_user_data; /**< Data for unix_user_function */
DBusFreeFunction free_unix_user_data; /**< Function to free unix_user_data */
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 */
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 */
unsigned int unused_bytes_recovered : 1; /**< #TRUE if we've recovered unused bytes from auth */
};
dbus_bool_t _dbus_transport_init_base (DBusTransport *transport,
const DBusTransportVTable *vtable,
dbus_bool_t server,
const DBusString *address);
void _dbus_transport_finalize_base (DBusTransport *transport);
DBUS_END_DECLS;
#endif /* DBUS_TRANSPORT_PROTECTED_H */
|
