|
D-Bus 1.14.10
|
"Backend" for a DBusConnection. More...
Typedefs | |
| typedef struct DBusTransport | DBusTransport |
| Opaque object representing a way message stream. More... | |
"Backend" for a DBusConnection.
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 34 of file dbus-transport.h.
| dbus_bool_t _dbus_transport_can_pass_unix_fd | ( | DBusTransport * | transport | ) |
Returns TRUE if the transport supports sending unix fds.
| transport | the transport |
Definition at line 855 of file dbus-transport.c.
Referenced by dbus_connection_can_send_type(), dbus_connection_send(), dbus_connection_send_preallocated(), dbus_connection_send_with_reply(), and dbus_connection_send_with_reply_and_block().
| 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 505 of file dbus-transport.c.
References _dbus_assert, DBusTransportVTable::disconnect, disconnected, NULL, TRUE, and vtable.
Referenced by _dbus_transport_finalize_base(), _dbus_transport_queue_messages(), and _dbus_transport_try_to_authenticate().
| 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 996 of file dbus-transport.c.
References _dbus_assert, _dbus_transport_ref(), _dbus_transport_unref(), disconnected, DBusTransportVTable::do_iteration, NULL, and vtable.
| 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 216 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, 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 868 of file dbus-transport.c.
References address.
| 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().
| transport | the transport |
| data | return location for the ADT audit data |
| data_size | return length of audit data |
Definition at line 1397 of file dbus-transport.c.
References _dbus_auth_get_identity(), _dbus_credentials_get_adt_audit_data(), _dbus_credentials_get_adt_audit_data_size(), _dbus_credentials_include(), auth, authenticated, FALSE, NULL, and TRUE.
Referenced by dbus_connection_get_adt_audit_session_data().
| DBusCredentials * _dbus_transport_get_credentials | ( | DBusTransport * | transport | ) |
If the transport has already been authenticated, return its credentials.
If not, return NULL.
The caller must ref the returned credentials object if it wants to keep it.
Definition at line 1483 of file dbus-transport.c.
References _dbus_auth_get_identity(), auth, authenticated, and FALSE.
| 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 1121 of file dbus-transport.c.
References _dbus_auth_do_work(), _dbus_counter_get_size_value(), _dbus_counter_get_unix_fd_value(), _dbus_transport_try_to_authenticate(), auth, DBUS_DISPATCH_COMPLETE, DBUS_DISPATCH_NEED_MEMORY, live_messages, max_live_messages_size, max_live_messages_unix_fds, and unused_bytes_recovered.
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 833 of file dbus-transport.c.
References _dbus_auth_get_identity(), _dbus_credentials_are_anonymous(), auth, authenticated, FALSE, and TRUE.
Referenced by dbus_connection_get_is_anonymous().
| 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 530 of file dbus-transport.c.
References disconnected.
| dbus_bool_t _dbus_transport_get_linux_security_label | ( | DBusTransport * | transport, |
| char ** | label_p | ||
| ) |
Definition at line 1449 of file dbus-transport.c.
| long _dbus_transport_get_max_message_size | ( | DBusTransport * | transport | ) |
See dbus_connection_get_max_message_size().
| transport | the transport |
Definition at line 1245 of file dbus-transport.c.
References _dbus_message_loader_get_max_message_size(), and loader.
Referenced by dbus_connection_get_max_message_size().
| long _dbus_transport_get_max_message_unix_fds | ( | DBusTransport * | transport | ) |
See dbus_connection_get_max_message_unix_fds().
| transport | the transport |
Definition at line 1257 of file dbus-transport.c.
References _dbus_message_loader_get_max_message_unix_fds(), and loader.
Referenced by dbus_connection_get_max_message_unix_fds().
| long _dbus_transport_get_max_received_size | ( | DBusTransport * | transport | ) |
See dbus_connection_get_max_received_size().
| transport | the transport |
Definition at line 1305 of file dbus-transport.c.
References max_live_messages_size.
Referenced by dbus_connection_get_max_received_size().
| long _dbus_transport_get_max_received_unix_fds | ( | DBusTransport * | transport | ) |
See dbus_connection_set_max_received_unix_fds().
| transport | the transport |
Definition at line 1317 of file dbus-transport.c.
References max_live_messages_unix_fds.
Referenced by dbus_connection_get_max_received_unix_fds().
| int _dbus_transport_get_pending_fds_count | ( | DBusTransport * | transport | ) |
Return how many file descriptors are pending in the loader.
| transport | the transport |
Definition at line 1584 of file dbus-transport.c.
References _dbus_message_loader_get_pending_fds_count(), and loader.
Referenced by _dbus_connection_get_pending_fds_count().
| 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 881 of file dbus-transport.c.
References _dbus_auth_get_guid_from_server(), auth, authenticated, expected_guid, is_server, and NULL.
Referenced by dbus_connection_get_server_id().
| dbus_bool_t _dbus_transport_get_socket_fd | ( | DBusTransport * | transport, |
| DBusSocket * | fd_p | ||
| ) |
Get the socket file descriptor, if any.
| transport | the transport |
| fd_p | pointer to fill in with the descriptor |
Definition at line 963 of file dbus-transport.c.
References _dbus_transport_ref(), _dbus_transport_unref(), disconnected, FALSE, DBusTransportVTable::get_socket_fd, NULL, and vtable.
| 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 1363 of file dbus-transport.c.
References _dbus_auth_get_identity(), _dbus_credentials_get_pid(), _dbus_credentials_include(), auth, authenticated, DBUS_PID_UNSET, FALSE, and TRUE.
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 1330 of file dbus-transport.c.
References _dbus_auth_get_identity(), _dbus_credentials_get_unix_uid(), _dbus_credentials_include(), _DBUS_INT32_MAX, auth, authenticated, FALSE, and TRUE.
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 1499 of file dbus-transport.c.
References _dbus_auth_get_identity(), _dbus_credentials_get_windows_sid(), _dbus_credentials_include(), _dbus_strdup(), auth, authenticated, FALSE, NULL, and TRUE.
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 901 of file dbus-transport.c.
References _dbus_assert, _dbus_transport_ref(), _dbus_transport_unref(), _dbus_warn_check_failed(), _dbus_watch_ref(), _dbus_watch_sanitize_condition(), _dbus_watch_unref(), dbus_watch_get_socket(), disconnected, DBusTransportVTable::handle_watch, NULL, TRUE, and vtable.
| 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 102 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, loader, max_live_messages_size, max_live_messages_unix_fds, NULL, receive_credentials_pending, refcount, send_credentials_pending, 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 367 of file dbus-transport.c.
References _DBUS_N_ELEMENTS, _dbus_strdup(), dbus_address_entry_get_value(), DBUS_ERROR_INIT, and NULL.
| dbus_bool_t _dbus_transport_peek_is_authenticated | ( | DBusTransport * | transport | ) |
Returns TRUE if we have been authenticated.
It will return TRUE even if the transport is now disconnected, but was ever authenticated before disconnecting.
This replaces the older _dbus_transport_get_is_authenticated() which had side-effects.
| transport | the transport |
Definition at line 704 of file dbus-transport.c.
References authenticated.
Referenced by _dbus_connection_queue_received_message_link().
| 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 1160 of file dbus-transport.c.
References _dbus_assert, _dbus_connection_queue_received_message_link(), _dbus_message_add_counter(), _dbus_message_loader_get_is_corrupted(), _dbus_message_loader_pop_message_link(), _dbus_message_loader_putback_message_link(), _dbus_transport_disconnect(), _dbus_transport_get_dispatch_status(), connection, DBusList::data, DBUS_DISPATCH_DATA_REMAINS, DBUS_DISPATCH_NEED_MEMORY, live_messages, DBusTransportVTable::live_messages_changed, loader, NULL, and vtable.
| DBusTransport * _dbus_transport_ref | ( | DBusTransport * | transport | ) |
Increments the reference count for the transport.
| transport | the transport. |
Definition at line 463 of file dbus-transport.c.
References _dbus_assert, and refcount.
Referenced by _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 1572 of file dbus-transport.c.
References allow_anonymous, and FALSE.
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 1559 of file dbus-transport.c.
References _dbus_auth_set_mechanisms(), and auth.
| 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 939 of file dbus-transport.c.
References _dbus_assert, _dbus_transport_ref(), _dbus_transport_unref(), connection, DBusTransportVTable::connection_set, NULL, and vtable.
| 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 1219 of file dbus-transport.c.
References _dbus_message_loader_set_max_message_size(), and loader.
Referenced by dbus_connection_set_max_message_size().
| void _dbus_transport_set_max_message_unix_fds | ( | DBusTransport * | transport, |
| long | n | ||
| ) |
See dbus_connection_set_max_message_unix_fds().
| transport | the transport |
| n | the max number of unix fds of a single message |
Definition at line 1232 of file dbus-transport.c.
References _dbus_message_loader_set_max_message_unix_fds(), and loader.
Referenced by dbus_connection_set_max_message_unix_fds().
| 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 1269 of file dbus-transport.c.
References _dbus_counter_set_notify(), live_messages, max_live_messages_size, and max_live_messages_unix_fds.
Referenced by dbus_connection_set_max_received_size().
| void _dbus_transport_set_max_received_unix_fds | ( | DBusTransport * | transport, |
| long | n | ||
| ) |
See dbus_connection_set_max_received_unix_fds().
| transport | the transport |
| n | the max unix fds of all incoming messages |
Definition at line 1287 of file dbus-transport.c.
References _dbus_counter_set_notify(), live_messages, max_live_messages_size, and max_live_messages_unix_fds.
Referenced by dbus_connection_set_max_received_unix_fds().
| void _dbus_transport_set_pending_fds_function | ( | DBusTransport * | transport, |
| void(*)(void *) | callback, | ||
| void * | data | ||
| ) |
Register a function to be called whenever the number of pending file descriptors in the loader change.
| transport | the transport |
| callback | the callback |
Definition at line 1597 of file dbus-transport.c.
References _dbus_message_loader_set_pending_fds_function(), and loader.
Referenced by _dbus_connection_set_pending_fds_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().
| 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 1433 of file dbus-transport.c.
References free_unix_user_data, unix_user_data, and unix_user_function.
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 1535 of file dbus-transport.c.
References free_windows_user_data, windows_user_data, and windows_user_function.
Referenced by dbus_connection_set_windows_user_function().
| dbus_bool_t _dbus_transport_try_to_authenticate | ( | DBusTransport * | transport | ) |
Returns TRUE if we have been authenticated.
It will return TRUE even if the transport is now disconnected, but was ever authenticated before disconnecting.
If we have not finished authenticating, but we have enough buffered input to finish the job, then this function will do so before it returns.
This used to be called _dbus_transport_get_is_authenticated(), but that name seems inappropriate for a function with side-effects.
| transport | the transport |
Definition at line 727 of file dbus-transport.c.
References _dbus_assert, _dbus_assert_not_reached, _dbus_auth_do_work(), _dbus_auth_get_guid_from_server(), _dbus_auth_get_identity(), _dbus_connection_ref_unlocked(), _dbus_connection_unref_unlocked(), _dbus_credentials_include(), _dbus_transport_disconnect(), auth, authenticated, connection, disconnected, expected_guid, FALSE, is_server, NULL, receive_credentials_pending, send_credentials_pending, TRUE, and unix_user_function.
Referenced by _dbus_transport_get_dispatch_status(), dbus_connection_get_adt_audit_session_data(), dbus_connection_get_is_authenticated(), dbus_connection_get_unix_process_id(), dbus_connection_get_unix_user(), and dbus_connection_get_windows_user().
| 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 480 of file dbus-transport.c.
References _dbus_assert, DBusTransportVTable::finalize, NULL, refcount, and vtable.
Referenced by _dbus_transport_do_iteration(), _dbus_transport_get_socket_fd(), _dbus_transport_handle_watch(), and _dbus_transport_set_connection().
| DBusTransportOpenResult(* { ... } ::func) (DBusAddressEntry *entry, DBusTransport **transport_p, DBusError *error) |
Definition at line 346 of file dbus-transport.c.
1.9.4