D-Bus 1.12.4

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-protocol.h>
29#include <dbus/dbus-address.h>
30
31 DBUS_BEGIN_DECLS
32
33 typedef struct DBusTransport DBusTransport;
34
35 DBusTransport* _dbus_transport_open (DBusAddressEntry *entry,
36 DBusError *error);
37 DBusTransport* _dbus_transport_ref (DBusTransport *transport);
38 void _dbus_transport_unref (DBusTransport *transport);
39 void _dbus_transport_disconnect (DBusTransport *transport);
40 dbus_bool_t _dbus_transport_get_is_connected (DBusTransport *transport);
41 dbus_bool_t _dbus_transport_peek_is_authenticated (DBusTransport *transport);
42 dbus_bool_t _dbus_transport_try_to_authenticate (DBusTransport *transport);
43 dbus_bool_t _dbus_transport_get_is_anonymous (DBusTransport *transport);
44 dbus_bool_t _dbus_transport_can_pass_unix_fd (DBusTransport *transport);
45
46 const char* _dbus_transport_get_address (DBusTransport *transport);
47 const char* _dbus_transport_get_server_id (DBusTransport *transport);
48 dbus_bool_t _dbus_transport_handle_watch (DBusTransport *transport,
49 DBusWatch *watch,
50 unsigned int condition);
51 dbus_bool_t _dbus_transport_set_connection (DBusTransport *transport,
52 DBusConnection *connection);
53 void _dbus_transport_do_iteration (DBusTransport *transport,
54 unsigned int flags,
55 int timeout_milliseconds);
56 DBusDispatchStatus _dbus_transport_get_dispatch_status (DBusTransport *transport);
57 dbus_bool_t _dbus_transport_queue_messages (DBusTransport *transport);
58
59 void _dbus_transport_set_max_message_size (DBusTransport *transport,
60 long size);
61 long _dbus_transport_get_max_message_size (DBusTransport *transport);
62 void _dbus_transport_set_max_received_size (DBusTransport *transport,
63 long size);
64 long _dbus_transport_get_max_received_size (DBusTransport *transport);
65
66 void _dbus_transport_set_max_message_unix_fds (DBusTransport *transport,
67 long n);
68 long _dbus_transport_get_max_message_unix_fds (DBusTransport *transport);
69 void _dbus_transport_set_max_received_unix_fds(DBusTransport *transport,
70 long n);
71 long _dbus_transport_get_max_received_unix_fds(DBusTransport *transport);
72
73 dbus_bool_t _dbus_transport_get_socket_fd (DBusTransport *transport,
74 DBusSocket *fd_p);
75 dbus_bool_t _dbus_transport_get_unix_user (DBusTransport *transport,
76 unsigned long *uid);
77 dbus_bool_t _dbus_transport_get_unix_process_id (DBusTransport *transport,
78 unsigned long *pid);
79 dbus_bool_t _dbus_transport_get_adt_audit_session_data (DBusTransport *transport,
80 void **data,
81 int *data_size);
82 void _dbus_transport_set_unix_user_function (DBusTransport *transport,
83 DBusAllowUnixUserFunction function,
84 void *data,
85 DBusFreeFunction free_data_function,
86 void **old_data,
87 DBusFreeFunction *old_free_data_function);
88 dbus_bool_t _dbus_transport_get_windows_user (DBusTransport *transport,
89 char **windows_sid_p);
90 dbus_bool_t _dbus_transport_get_linux_security_label (DBusTransport *transport,
91 char **label_p);
92
93 void _dbus_transport_set_windows_user_function (DBusTransport *transport,
94 DBusAllowWindowsUserFunction function,
95 void *data,
96 DBusFreeFunction free_data_function,
97 void **old_data,
98 DBusFreeFunction *old_free_data_function);
99 dbus_bool_t _dbus_transport_set_auth_mechanisms (DBusTransport *transport,
100 const char **mechanisms);
101 void _dbus_transport_set_allow_anonymous (DBusTransport *transport,
102 dbus_bool_t value);
103 int _dbus_transport_get_pending_fds_count (DBusTransport *transport);
104 void _dbus_transport_set_pending_fds_function (DBusTransport *transport,
105 void (* callback) (void *),
106 void *data);
107
108/* if DBUS_ENABLE_STATS */
109 void _dbus_transport_get_stats (DBusTransport *transport,
110 dbus_uint32_t *queue_bytes,
111 dbus_uint32_t *queue_fds,
112 dbus_uint32_t *peak_queue_bytes,
113 dbus_uint32_t *peak_queue_fds);
114
115 DBUS_END_DECLS
116
117#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:64
_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:1222
_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:1272
_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:1124
_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:1546
_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:1571
_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:1400
_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:1486
_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:1163
_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:966
_dbus_transport_get_address
const char * _dbus_transport_get_address(DBusTransport *transport)
Gets the address of a transport.
Definition: dbus-transport.c:871
_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:904
_dbus_transport_ref
DBusTransport * _dbus_transport_ref(DBusTransport *transport)
Increments the reference count for the transport.
Definition: dbus-transport.c:466
_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:707
_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:1559
_dbus_transport_disconnect
void _dbus_transport_disconnect(DBusTransport *transport)
Closes our end of the connection to a remote application.
Definition: dbus-transport.c:508
_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:1308
_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:942
_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:1436
_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:1260
_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:1290
_dbus_transport_unref
void _dbus_transport_unref(DBusTransport *transport)
Decrements the reference count for the transport.
Definition: dbus-transport.c:483
_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:858
_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:730
_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:999
_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:1320
_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:533
_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:1235
_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:1584
_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:1522
_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:1248
_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:1366
_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:370
_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:884
_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:836
_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:1333
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
dbus_uint32_t
unsigned int dbus_uint32_t
A 32-bit unsigned integer on all platforms.
Definition: dbus-arch-deps.h:43
DBusAddressEntry
Internals of DBusAddressEntry.
Definition: dbus-address.c:44
DBusConnection
Implementation details of DBusConnection.
Definition: dbus-connection.c:257
DBusError
Object representing an exception.
Definition: dbus-errors.h:49
DBusSocket
Socket interface.
Definition: dbus-sysdeps.h:149
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