Typedefs | |
typedef struct DBusTransport | DBusTransport |
Opaque object representing a way message stream. | |
Functions | |
dbus_bool_t | _dbus_transport_init_base (DBusTransport *transport, const DBusTransportVTable *vtable, const DBusString *server_guid, const DBusString *address) |
Initializes the base class members of DBusTransport. | |
void | _dbus_transport_finalize_base (DBusTransport *transport) |
Finalizes base class members of DBusTransport. | |
DBusTransport * | _dbus_transport_open (DBusAddressEntry *entry, DBusError *error) |
Try to open a new transport for the given address entry. | |
DBusTransport * | _dbus_transport_ref (DBusTransport *transport) |
Increments the reference count for the transport. | |
void | _dbus_transport_unref (DBusTransport *transport) |
Decrements the reference count for the transport. | |
void | _dbus_transport_disconnect (DBusTransport *transport) |
Closes our end of the connection to a remote application. | |
dbus_bool_t | _dbus_transport_get_is_connected (DBusTransport *transport) |
Returns TRUE if the transport has not been disconnected. | |
dbus_bool_t | _dbus_transport_get_is_authenticated (DBusTransport *transport) |
Returns TRUE if we have been authenticated. | |
dbus_bool_t | _dbus_transport_get_is_anonymous (DBusTransport *transport) |
See dbus_connection_get_is_anonymous(). | |
const char * | _dbus_transport_get_address (DBusTransport *transport) |
Gets the address of a transport. | |
const char * | _dbus_transport_get_server_id (DBusTransport *transport) |
Gets the id of the server we are connected to (see dbus_server_get_id()). | |
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 given condition. | |
dbus_bool_t | _dbus_transport_set_connection (DBusTransport *transport, DBusConnection *connection) |
Sets the connection using this transport. | |
dbus_bool_t | _dbus_transport_get_socket_fd (DBusTransport *transport, int *fd_p) |
Get the socket file descriptor, if any. | |
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 appropriate, queueing incoming messages and sending outgoing messages. | |
DBusDispatchStatus | _dbus_transport_get_dispatch_status (DBusTransport *transport) |
Reports our current dispatch status (whether there's buffered data to be queued as messages, or not, or we need memory). | |
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 queueing those messages on the connection. | |
void | _dbus_transport_set_max_message_size (DBusTransport *transport, long size) |
See dbus_connection_set_max_message_size(). | |
long | _dbus_transport_get_max_message_size (DBusTransport *transport) |
See dbus_connection_get_max_message_size(). | |
void | _dbus_transport_set_max_received_size (DBusTransport *transport, long size) |
See dbus_connection_set_max_received_size(). | |
long | _dbus_transport_get_max_received_size (DBusTransport *transport) |
See dbus_connection_get_max_received_size(). | |
dbus_bool_t | _dbus_transport_get_unix_user (DBusTransport *transport, unsigned long *uid) |
See dbus_connection_get_unix_user(). | |
dbus_bool_t | _dbus_transport_get_unix_process_id (DBusTransport *transport, unsigned long *pid) |
See dbus_connection_get_unix_process_id(). | |
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(). | |
dbus_bool_t | _dbus_transport_get_windows_user (DBusTransport *transport, char **windows_sid_p) |
See dbus_connection_get_windows_user(). | |
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(). | |
dbus_bool_t | _dbus_transport_set_auth_mechanisms (DBusTransport *transport, const char **mechanisms) |
Sets the SASL authentication mechanisms supported by this transport. | |
void | _dbus_transport_set_allow_anonymous (DBusTransport *transport, dbus_bool_t value) |
See dbus_connection_set_allow_anonymous(). |
Types and functions related to DBusTransport. A transport is an abstraction that can send and receive data via various kinds of network connections or other IPC mechanisms.
Opaque object representing a way message stream.
DBusTransport abstracts various kinds of actual transport mechanism, such as different network protocols, or encryption schemes.
Definition at line 33 of file dbus-transport.h.
void _dbus_transport_disconnect | ( | DBusTransport * | transport | ) |
Closes our end of the connection to a remote application.
Further attempts to use this transport will fail. Only the first call to _dbus_transport_disconnect() will have an effect.
transport | the transport. |
Definition at line 471 of file dbus-transport.c.
Referenced by _dbus_transport_finalize_base(), _dbus_transport_get_is_authenticated(), and _dbus_transport_queue_messages().
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 appropriate, queueing incoming messages and sending outgoing messages.
This is the backend for _dbus_connection_do_iteration(). See _dbus_connection_do_iteration() for full details.
transport | the transport. | |
flags | indicates whether to read or write, and whether to block. | |
timeout_milliseconds | if blocking, timeout or -1 for no timeout. |
Definition at line 915 of file dbus-transport.c.
Referenced by _dbus_connection_do_iteration_unlocked().
void _dbus_transport_finalize_base | ( | DBusTransport * | transport | ) |
Finalizes base class members of DBusTransport.
Chained up to from subclass finalizers.
transport | the transport. |
Definition at line 202 of file dbus-transport.c.
References _dbus_auth_unref(), _dbus_counter_set_notify(), _dbus_counter_unref(), _dbus_credentials_unref(), _dbus_message_loader_unref(), _dbus_transport_disconnect(), address, auth, credentials, dbus_free(), disconnected, expected_guid, free_unix_user_data, free_windows_user_data, live_messages_size, loader, NULL, unix_user_data, and windows_user_data.
const char* _dbus_transport_get_address | ( | DBusTransport * | transport | ) |
Gets the address of a transport.
It will be NULL for a server-side transport.
transport | the transport |
Definition at line 789 of file dbus-transport.c.
DBusDispatchStatus _dbus_transport_get_dispatch_status | ( | DBusTransport * | transport | ) |
Reports our current dispatch status (whether there's buffered data to be queued as messages, or not, or we need memory).
transport | the transport |
Definition at line 1036 of file dbus-transport.c.
Referenced by _dbus_transport_queue_messages().
dbus_bool_t _dbus_transport_get_is_anonymous | ( | DBusTransport * | transport | ) |
See dbus_connection_get_is_anonymous().
transport | the transport |
Definition at line 766 of file dbus-transport.c.
Referenced by dbus_connection_get_is_anonymous().
dbus_bool_t _dbus_transport_get_is_authenticated | ( | DBusTransport * | transport | ) |
Returns TRUE if we have been authenticated.
Will return TRUE even if the transport is disconnected.
transport | the transport |
Definition at line 658 of file dbus-transport.c.
Referenced by _dbus_connection_queue_received_message_link(), _dbus_transport_get_dispatch_status(), dbus_connection_get_is_authenticated(), dbus_connection_get_unix_process_id(), dbus_connection_get_unix_user(), and dbus_connection_get_windows_user().
dbus_bool_t _dbus_transport_get_is_connected | ( | DBusTransport * | transport | ) |
Returns TRUE if the transport has not been disconnected.
Disconnection can result from _dbus_transport_disconnect() or because the server drops its end of the connection.
transport | the transport. |
Definition at line 496 of file dbus-transport.c.
Referenced by dbus_connection_unref().
long _dbus_transport_get_max_message_size | ( | DBusTransport * | transport | ) |
See dbus_connection_get_max_message_size().
transport | the transport |
Definition at line 1139 of file dbus-transport.c.
Referenced by dbus_connection_get_max_message_size().
long _dbus_transport_get_max_received_size | ( | DBusTransport * | transport | ) |
See dbus_connection_get_max_received_size().
transport | the transport |
Definition at line 1169 of file dbus-transport.c.
Referenced by dbus_connection_get_max_received_size().
const char* _dbus_transport_get_server_id | ( | DBusTransport * | transport | ) |
Gets the id of the server we are connected to (see dbus_server_get_id()).
Only works on client side.
transport | the transport |
Definition at line 802 of file dbus-transport.c.
Referenced by dbus_connection_get_server_id().
dbus_bool_t _dbus_transport_get_socket_fd | ( | DBusTransport * | transport, | |
int * | fd_p | |||
) |
Get the socket file descriptor, if any.
transport | the transport | |
fd_p | pointer to fill in with the descriptor |
Definition at line 882 of file dbus-transport.c.
Referenced by dbus_connection_get_socket().
dbus_bool_t _dbus_transport_get_unix_process_id | ( | DBusTransport * | transport, | |
unsigned long * | pid | |||
) |
See dbus_connection_get_unix_process_id().
transport | the transport | |
pid | return location for the process ID |
Definition at line 1215 of file dbus-transport.c.
Referenced by dbus_connection_get_unix_process_id().
dbus_bool_t _dbus_transport_get_unix_user | ( | DBusTransport * | transport, | |
unsigned long * | uid | |||
) |
See dbus_connection_get_unix_user().
transport | the transport | |
uid | return location for the user ID |
Definition at line 1182 of file dbus-transport.c.
Referenced by dbus_connection_get_unix_user().
dbus_bool_t _dbus_transport_get_windows_user | ( | DBusTransport * | transport, | |
char ** | windows_sid_p | |||
) |
See dbus_connection_get_windows_user().
transport | the transport | |
windows_sid_p | return location for the user ID |
Definition at line 1274 of file dbus-transport.c.
Referenced by dbus_connection_get_windows_user().
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 given condition.
transport | the transport. | |
watch | the watch. | |
condition | the current state of the watched file descriptor. |
Definition at line 820 of file dbus-transport.c.
Referenced by _dbus_connection_handle_watch().
dbus_bool_t _dbus_transport_init_base | ( | DBusTransport * | transport, | |
const DBusTransportVTable * | vtable, | |||
const DBusString * | server_guid, | |||
const DBusString * | address | |||
) |
Initializes the base class members of DBusTransport.
Chained up to by subclasses in their constructor. The server GUID is the globally unique ID for the server creating this connection and will be NULL for the client side of a connection. The GUID is in hex format.
transport | the transport being created. | |
vtable | the subclass vtable. | |
server_guid | non-NULL if this transport is on the server side of a connection | |
address | the address of the transport |
Definition at line 93 of file dbus-transport.c.
References _dbus_assert, _dbus_auth_client_new(), _dbus_auth_server_new(), _dbus_auth_unref(), _dbus_counter_new(), _dbus_counter_set_notify(), _dbus_counter_unref(), _dbus_credentials_new(), _dbus_credentials_unref(), _dbus_message_loader_new(), _dbus_message_loader_unref(), _dbus_string_copy_data(), address, auth, authenticated, credentials, disconnected, expected_guid, FALSE, free_unix_user_data, free_windows_user_data, is_server, live_messages_size, loader, max_live_messages_size, NULL, receive_credentials_pending, refcount, send_credentials_pending, TRUE, unix_user_data, unix_user_function, vtable, windows_user_data, and windows_user_function.
DBusTransport* _dbus_transport_open | ( | DBusAddressEntry * | entry, | |
DBusError * | error | |||
) |
Try to open a new transport for the given address entry.
(This opens a client-side-of-the-connection transport.)
entry | the address entry | |
error | location to store reason for failure. |
Definition at line 350 of file dbus-transport.c.
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 queueing those messages on the connection.
transport | the transport |
Definition at line 1074 of file dbus-transport.c.
DBusTransport* _dbus_transport_ref | ( | DBusTransport * | transport | ) |
Increments the reference count for the transport.
transport | the transport. |
Definition at line 429 of file dbus-transport.c.
Referenced by _dbus_connection_new_for_transport(), _dbus_transport_do_iteration(), _dbus_transport_get_socket_fd(), _dbus_transport_handle_watch(), and _dbus_transport_set_connection().
void _dbus_transport_set_allow_anonymous | ( | DBusTransport * | transport, | |
dbus_bool_t | value | |||
) |
See dbus_connection_set_allow_anonymous().
transport | the transport | |
value | TRUE to allow anonymous connection |
Definition at line 1347 of file dbus-transport.c.
Referenced by dbus_connection_set_allow_anonymous().
dbus_bool_t _dbus_transport_set_auth_mechanisms | ( | DBusTransport * | transport, | |
const char ** | mechanisms | |||
) |
Sets the SASL authentication mechanisms supported by this transport.
transport | the transport | |
mechanisms | the NULL-terminated array of mechanisms |
Definition at line 1334 of file dbus-transport.c.
dbus_bool_t _dbus_transport_set_connection | ( | DBusTransport * | transport, | |
DBusConnection * | connection | |||
) |
Sets the connection using this transport.
Allows the transport to add watches to the connection, queue incoming messages, and pull outgoing messages.
transport | the transport. | |
connection | the connection. |
Definition at line 858 of file dbus-transport.c.
Referenced by _dbus_connection_new_for_transport().
void _dbus_transport_set_max_message_size | ( | DBusTransport * | transport, | |
long | size | |||
) |
See dbus_connection_set_max_message_size().
transport | the transport | |
size | the max size of a single message |
Definition at line 1126 of file dbus-transport.c.
Referenced by dbus_connection_set_max_message_size().
void _dbus_transport_set_max_received_size | ( | DBusTransport * | transport, | |
long | size | |||
) |
See dbus_connection_set_max_received_size().
transport | the transport | |
size | the max size of all incoming messages |
Definition at line 1151 of file dbus-transport.c.
Referenced by dbus_connection_set_max_received_size().
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().
transport | the transport | |
function | the predicate | |
data | data to pass to the predicate | |
free_data_function | function to free the data | |
old_data | the old user data to be freed | |
old_free_data_function | old free data function to free it with |
Definition at line 1251 of file dbus-transport.c.
Referenced by dbus_connection_set_unix_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().
transport | the transport | |
function | the predicate | |
data | data to pass to the predicate | |
free_data_function | function to free the data | |
old_data | the old user data to be freed | |
old_free_data_function | old free data function to free it with |
Definition at line 1310 of file dbus-transport.c.
Referenced by dbus_connection_set_windows_user_function().
void _dbus_transport_unref | ( | DBusTransport * | transport | ) |
Decrements the reference count for the transport.
Disconnects and finalizes the transport if the reference count reaches zero.
transport | the transport. |
Definition at line 446 of file dbus-transport.c.
Referenced by _dbus_transport_do_iteration(), _dbus_transport_get_socket_fd(), _dbus_transport_handle_watch(), and _dbus_transport_set_connection().