D-Bus 1.13.18

dbus-transport.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-transport.h 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 *
22 */
23#ifndef DBUS_TRANSPORT_H
24#define DBUS_TRANSPORT_H
25
26#include <dbus/dbus-internals.h>
27#include <dbus/dbus-connection.h>
28#include <dbus/dbus-credentials.h>
29#include <dbus/dbus-protocol.h>
30#include <dbus/dbus-address.h>
31
32 DBUS_BEGIN_DECLS
33
34 typedef struct DBusTransport DBusTransport;
35
36 DBusTransport* _dbus_transport_open (DBusAddressEntry *entry,
37 DBusError *error);
38 DBusTransport* _dbus_transport_ref (DBusTransport *transport);
39 void _dbus_transport_unref (DBusTransport *transport);
40 void _dbus_transport_disconnect (DBusTransport *transport);
41 dbus_bool_t _dbus_transport_get_is_connected (DBusTransport *transport);
42 dbus_bool_t _dbus_transport_peek_is_authenticated (DBusTransport *transport);
43 dbus_bool_t _dbus_transport_try_to_authenticate (DBusTransport *transport);
44 dbus_bool_t _dbus_transport_get_is_anonymous (DBusTransport *transport);
45 dbus_bool_t _dbus_transport_can_pass_unix_fd (DBusTransport *transport);
46
47 const char* _dbus_transport_get_address (DBusTransport *transport);
48 const char* _dbus_transport_get_server_id (DBusTransport *transport);
49 dbus_bool_t _dbus_transport_handle_watch (DBusTransport *transport,
50 DBusWatch *watch,
51 unsigned int condition);
52 dbus_bool_t _dbus_transport_set_connection (DBusTransport *transport,
53 DBusConnection *connection);
54 void _dbus_transport_do_iteration (DBusTransport *transport,
55 unsigned int flags,
56 int timeout_milliseconds);
57 DBusDispatchStatus _dbus_transport_get_dispatch_status (DBusTransport *transport);
58 dbus_bool_t _dbus_transport_queue_messages (DBusTransport *transport);
59
60 void _dbus_transport_set_max_message_size (DBusTransport *transport,
61 long size);
62 long _dbus_transport_get_max_message_size (DBusTransport *transport);
63 void _dbus_transport_set_max_received_size (DBusTransport *transport,
64 long size);
65 long _dbus_transport_get_max_received_size (DBusTransport *transport);
66
67 void _dbus_transport_set_max_message_unix_fds (DBusTransport *transport,
68 long n);
69 long _dbus_transport_get_max_message_unix_fds (DBusTransport *transport);
70 void _dbus_transport_set_max_received_unix_fds(DBusTransport *transport,
71 long n);
72 long _dbus_transport_get_max_received_unix_fds(DBusTransport *transport);
73
74 dbus_bool_t _dbus_transport_get_socket_fd (DBusTransport *transport,
75 DBusSocket *fd_p);
76 dbus_bool_t _dbus_transport_get_unix_user (DBusTransport *transport,
77 unsigned long *uid);
78 dbus_bool_t _dbus_transport_get_unix_process_id (DBusTransport *transport,
79 unsigned long *pid);
80 dbus_bool_t _dbus_transport_get_adt_audit_session_data (DBusTransport *transport,
81 void **data,
82 int *data_size);
83 void _dbus_transport_set_unix_user_function (DBusTransport *transport,
84 DBusAllowUnixUserFunction function,
85 void *data,
86 DBusFreeFunction free_data_function,
87 void **old_data,
88 DBusFreeFunction *old_free_data_function);
89 dbus_bool_t _dbus_transport_get_windows_user (DBusTransport *transport,
90 char **windows_sid_p);
91 dbus_bool_t _dbus_transport_get_linux_security_label (DBusTransport *transport,
92 char **label_p);
93 DBusCredentials *_dbus_transport_get_credentials (DBusTransport *transport);
94
95 void _dbus_transport_set_windows_user_function (DBusTransport *transport,
96 DBusAllowWindowsUserFunction function,
97 void *data,
98 DBusFreeFunction free_data_function,
99 void **old_data,
100 DBusFreeFunction *old_free_data_function);
101 dbus_bool_t _dbus_transport_set_auth_mechanisms (DBusTransport *transport,
102 const char **mechanisms);
103 void _dbus_transport_set_allow_anonymous (DBusTransport *transport,
104 dbus_bool_t value);
105 int _dbus_transport_get_pending_fds_count (DBusTransport *transport);
106 void _dbus_transport_set_pending_fds_function (DBusTransport *transport,
107 void (* callback) (void *),
108 void *data);
109
110/* if DBUS_ENABLE_STATS */
111 void _dbus_transport_get_stats (DBusTransport *transport,
112 dbus_uint32_t *queue_bytes,
113 dbus_uint32_t *queue_fds,
114 dbus_uint32_t *peak_queue_bytes,
115 dbus_uint32_t *peak_queue_fds);
116
117 DBUS_END_DECLS
118
119#endif /* DBUS_TRANSPORT_H */
DBusAllowUnixUserFunction
dbus_bool_t(* DBusAllowUnixUserFunction)(DBusConnection *connection, unsigned long uid, void *data)
Called during authentication to check whether the given UNIX user ID is allowed to connect,...
Definition: dbus-connection.h:144
DBusDispatchStatus
DBusDispatchStatus
Indicates the status of incoming data on a DBusConnection.
Definition: dbus-connection.h:81
DBusAllowWindowsUserFunction
dbus_bool_t(* DBusAllowWindowsUserFunction)(DBusConnection *connection, const char *user_sid, void *data)
Called during authentication to check whether the given Windows user ID is allowed to connect,...
Definition: dbus-connection.h:154
DBUS_BEGIN_DECLS
#define DBUS_BEGIN_DECLS
Macro used prior to declaring functions in the D-Bus header files.
DBUS_END_DECLS
#define DBUS_END_DECLS
Macro used after declaring functions in the D-Bus header files.
DBusFreeFunction
void(* DBusFreeFunction)(void *memory)
The type of a function which frees a block of memory.
Definition: dbus-memory.h:63
_dbus_transport_set_max_message_size
void _dbus_transport_set_max_message_size(DBusTransport *transport, long size)
See dbus_connection_set_max_message_size().
Definition: dbus-transport.c:1219
_dbus_transport_set_max_received_size
void _dbus_transport_set_max_received_size(DBusTransport *transport, long size)
See dbus_connection_set_max_received_size().
Definition: dbus-transport.c:1269
_dbus_transport_get_dispatch_status
DBusDispatchStatus _dbus_transport_get_dispatch_status(DBusTransport *transport)
Reports our current dispatch status (whether there's buffered data to be queued as messages,...
Definition: dbus-transport.c:1121
_dbus_transport_set_auth_mechanisms
dbus_bool_t _dbus_transport_set_auth_mechanisms(DBusTransport *transport, const char **mechanisms)
Sets the SASL authentication mechanisms supported by this transport.
Definition: dbus-transport.c:1559
_dbus_transport_get_pending_fds_count
int _dbus_transport_get_pending_fds_count(DBusTransport *transport)
Return how many file descriptors are pending in the loader.
Definition: dbus-transport.c:1584
_dbus_transport_get_adt_audit_session_data
dbus_bool_t _dbus_transport_get_adt_audit_session_data(DBusTransport *transport, void **data, int *data_size)
See dbus_connection_get_adt_audit_session_data().
Definition: dbus-transport.c:1397
_dbus_transport_get_windows_user
dbus_bool_t _dbus_transport_get_windows_user(DBusTransport *transport, char **windows_sid_p)
See dbus_connection_get_windows_user().
Definition: dbus-transport.c:1499
_dbus_transport_queue_messages
dbus_bool_t _dbus_transport_queue_messages(DBusTransport *transport)
Processes data we've read while handling a watch, potentially converting some of it to messages and q...
Definition: dbus-transport.c:1160
_dbus_transport_get_socket_fd
dbus_bool_t _dbus_transport_get_socket_fd(DBusTransport *transport, DBusSocket *fd_p)
Get the socket file descriptor, if any.
Definition: dbus-transport.c:963
_dbus_transport_get_address
const char * _dbus_transport_get_address(DBusTransport *transport)
Gets the address of a transport.
Definition: dbus-transport.c:868
_dbus_transport_handle_watch
dbus_bool_t _dbus_transport_handle_watch(DBusTransport *transport, DBusWatch *watch, unsigned int condition)
Handles a watch by reading data, writing data, or disconnecting the transport, as appropriate for the...
Definition: dbus-transport.c:901
_dbus_transport_ref
DBusTransport * _dbus_transport_ref(DBusTransport *transport)
Increments the reference count for the transport.
Definition: dbus-transport.c:463
_dbus_transport_peek_is_authenticated
dbus_bool_t _dbus_transport_peek_is_authenticated(DBusTransport *transport)
Returns TRUE if we have been authenticated.
Definition: dbus-transport.c:704
_dbus_transport_set_allow_anonymous
void _dbus_transport_set_allow_anonymous(DBusTransport *transport, dbus_bool_t value)
See dbus_connection_set_allow_anonymous()
Definition: dbus-transport.c:1572
_dbus_transport_disconnect
void _dbus_transport_disconnect(DBusTransport *transport)
Closes our end of the connection to a remote application.
Definition: dbus-transport.c:505
_dbus_transport_get_max_received_size
long _dbus_transport_get_max_received_size(DBusTransport *transport)
See dbus_connection_get_max_received_size().
Definition: dbus-transport.c:1305
_dbus_transport_get_credentials
DBusCredentials * _dbus_transport_get_credentials(DBusTransport *transport)
If the transport has already been authenticated, return its credentials.
Definition: dbus-transport.c:1483
_dbus_transport_set_connection
dbus_bool_t _dbus_transport_set_connection(DBusTransport *transport, DBusConnection *connection)
Sets the connection using this transport.
Definition: dbus-transport.c:939
_dbus_transport_set_unix_user_function
void _dbus_transport_set_unix_user_function(DBusTransport *transport, DBusAllowUnixUserFunction function, void *data, DBusFreeFunction free_data_function, void **old_data, DBusFreeFunction *old_free_data_function)
See dbus_connection_set_unix_user_function().
Definition: dbus-transport.c:1433
_dbus_transport_get_max_message_unix_fds
long _dbus_transport_get_max_message_unix_fds(DBusTransport *transport)
See dbus_connection_get_max_message_unix_fds().
Definition: dbus-transport.c:1257
_dbus_transport_set_max_received_unix_fds
void _dbus_transport_set_max_received_unix_fds(DBusTransport *transport, long n)
See dbus_connection_set_max_received_unix_fds().
Definition: dbus-transport.c:1287
_dbus_transport_unref
void _dbus_transport_unref(DBusTransport *transport)
Decrements the reference count for the transport.
Definition: dbus-transport.c:480
_dbus_transport_can_pass_unix_fd
dbus_bool_t _dbus_transport_can_pass_unix_fd(DBusTransport *transport)
Returns TRUE if the transport supports sending unix fds.
Definition: dbus-transport.c:855
_dbus_transport_try_to_authenticate
dbus_bool_t _dbus_transport_try_to_authenticate(DBusTransport *transport)
Returns TRUE if we have been authenticated.
Definition: dbus-transport.c:727
_dbus_transport_do_iteration
void _dbus_transport_do_iteration(DBusTransport *transport, unsigned int flags, int timeout_milliseconds)
Performs a single poll()/select() on the transport's file descriptors and then reads/writes data as a...
Definition: dbus-transport.c:996
_dbus_transport_get_max_received_unix_fds
long _dbus_transport_get_max_received_unix_fds(DBusTransport *transport)
See dbus_connection_set_max_received_unix_fds().
Definition: dbus-transport.c:1317
_dbus_transport_get_is_connected
dbus_bool_t _dbus_transport_get_is_connected(DBusTransport *transport)
Returns TRUE if the transport has not been disconnected.
Definition: dbus-transport.c:530
_dbus_transport_set_max_message_unix_fds
void _dbus_transport_set_max_message_unix_fds(DBusTransport *transport, long n)
See dbus_connection_set_max_message_unix_fds().
Definition: dbus-transport.c:1232
_dbus_transport_set_pending_fds_function
void _dbus_transport_set_pending_fds_function(DBusTransport *transport, void(*callback)(void *), void *data)
Register a function to be called whenever the number of pending file descriptors in the loader change...
Definition: dbus-transport.c:1597
_dbus_transport_set_windows_user_function
void _dbus_transport_set_windows_user_function(DBusTransport *transport, DBusAllowWindowsUserFunction function, void *data, DBusFreeFunction free_data_function, void **old_data, DBusFreeFunction *old_free_data_function)
See dbus_connection_set_windows_user_function().
Definition: dbus-transport.c:1535
_dbus_transport_get_max_message_size
long _dbus_transport_get_max_message_size(DBusTransport *transport)
See dbus_connection_get_max_message_size().
Definition: dbus-transport.c:1245
_dbus_transport_get_unix_process_id
dbus_bool_t _dbus_transport_get_unix_process_id(DBusTransport *transport, unsigned long *pid)
See dbus_connection_get_unix_process_id().
Definition: dbus-transport.c:1363
_dbus_transport_open
DBusTransport * _dbus_transport_open(DBusAddressEntry *entry, DBusError *error)
Try to open a new transport for the given address entry.
Definition: dbus-transport.c:367
_dbus_transport_get_server_id
const char * _dbus_transport_get_server_id(DBusTransport *transport)
Gets the id of the server we are connected to (see dbus_server_get_id()).
Definition: dbus-transport.c:881
_dbus_transport_get_is_anonymous
dbus_bool_t _dbus_transport_get_is_anonymous(DBusTransport *transport)
See dbus_connection_get_is_anonymous().
Definition: dbus-transport.c:833
_dbus_transport_get_unix_user
dbus_bool_t _dbus_transport_get_unix_user(DBusTransport *transport, unsigned long *uid)
See dbus_connection_get_unix_user().
Definition: dbus-transport.c:1330
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusAddressEntry
Internals of DBusAddressEntry.
Definition: dbus-address.c:47
DBusConnection
Implementation details of DBusConnection.
Definition: dbus-connection.c:257
DBusCredentials
Definition: dbus-credentials.c:49
DBusError
Object representing an exception.
Definition: dbus-errors.h:49
DBusSocket
Socket interface.
Definition: dbus-sysdeps.h:181
DBusTransport
Object representing a transport such as a socket.
Definition: dbus-transport-protected.h:81
DBusTransport::connection
DBusConnection * connection
Connection owning this transport.
Definition: dbus-transport-protected.h:86
DBusWatch
Implementation of DBusWatch.
Definition: dbus-watch.c:41