D-Bus  1.9.2
Data Structures | Macros | Functions
DBusPendingCall implementation details

DBusPendingCall private implementation details. More...

Data Structures

struct  DBusPendingCall
 Implementation details of DBusPendingCall - all fields are private. More...
 

Macros

#define CONNECTION_LOCK(connection)   _dbus_connection_lock(connection)
 Internals of DBusPendingCall. More...
 
#define CONNECTION_UNLOCK(connection)   _dbus_connection_unlock(connection)
 shorter and more visible way to write _dbus_connection_unlock()
 

Functions

DBusPendingCall_dbus_pending_call_new_unlocked (DBusConnection *connection, int timeout_milliseconds, DBusTimeoutHandler timeout_handler)
 Creates a new pending reply object. More...
 
void _dbus_pending_call_set_reply_unlocked (DBusPendingCall *pending, DBusMessage *message)
 Sets the reply of a pending call with the given message, or if the message is NULL, by timing out the pending call. More...
 
void _dbus_pending_call_complete (DBusPendingCall *pending)
 Calls notifier function for the pending call and sets the call to completed. More...
 
void _dbus_pending_call_queue_timeout_error_unlocked (DBusPendingCall *pending, DBusConnection *connection)
 If the pending call hasn't been timed out, add its timeout error reply to the connection's incoming message queue. More...
 
dbus_bool_t _dbus_pending_call_is_timeout_added_unlocked (DBusPendingCall *pending)
 Checks to see if a timeout has been added. More...
 
void _dbus_pending_call_set_timeout_added_unlocked (DBusPendingCall *pending, dbus_bool_t is_added)
 Sets wether the timeout has been added. More...
 
DBusTimeout_dbus_pending_call_get_timeout_unlocked (DBusPendingCall *pending)
 Retrives the timeout. More...
 
dbus_uint32_t _dbus_pending_call_get_reply_serial_unlocked (DBusPendingCall *pending)
 Gets the reply's serial number. More...
 
void _dbus_pending_call_set_reply_serial_unlocked (DBusPendingCall *pending, dbus_uint32_t serial)
 Sets the reply's serial number. More...
 
DBusConnection_dbus_pending_call_get_connection_and_lock (DBusPendingCall *pending)
 Gets the connection associated with this pending call. More...
 
DBusConnection_dbus_pending_call_get_connection_unlocked (DBusPendingCall *pending)
 Gets the connection associated with this pending call. More...
 
dbus_bool_t _dbus_pending_call_set_timeout_error_unlocked (DBusPendingCall *pending, DBusMessage *message, dbus_uint32_t serial)
 Sets the reply message associated with the pending call to a timeout error. More...
 
DBusPendingCall_dbus_pending_call_ref_unlocked (DBusPendingCall *pending)
 Increments the reference count on a pending call, while the lock on its connection is already held. More...
 
void _dbus_pending_call_unref_and_unlock (DBusPendingCall *pending)
 Decrements the reference count on a pending call, freeing it if the count reaches 0. More...
 
dbus_bool_t _dbus_pending_call_get_completed_unlocked (DBusPendingCall *pending)
 Checks whether the pending call has received a reply yet, or not. More...
 
dbus_bool_t _dbus_pending_call_set_data_unlocked (DBusPendingCall *pending, dbus_int32_t slot, void *data, DBusFreeFunction free_data_func)
 Stores a pointer on a DBusPendingCall, along with an optional function to be used for freeing the data when the data is set again, or when the pending call is finalized. More...
 

Detailed Description

DBusPendingCall private implementation details.

The guts of DBusPendingCall and its methods.

Macro Definition Documentation

#define CONNECTION_LOCK (   connection)    _dbus_connection_lock(connection)

Internals of DBusPendingCall.

Opaque object representing a reply message that we're waiting for. shorter and more visible way to write _dbus_connection_lock()

Definition at line 53 of file dbus-pending-call.c.

Referenced by _dbus_connection_block_pending_call(), _dbus_connection_close_if_only_one_ref(), _dbus_connection_close_possibly_shared(), _dbus_connection_handle_watch(), _dbus_connection_lock(), _dbus_connection_new_for_transport(), _dbus_connection_remove_pending_call(), _dbus_pending_call_get_connection_and_lock(), _dbus_pending_call_set_data_unlocked(), dbus_connection_add_filter(), dbus_connection_borrow_message(), dbus_connection_can_send_type(), dbus_connection_close(), dbus_connection_dispatch(), dbus_connection_flush(), dbus_connection_get_adt_audit_session_data(), dbus_connection_get_dispatch_status(), dbus_connection_get_is_anonymous(), dbus_connection_get_is_authenticated(), dbus_connection_get_is_connected(), dbus_connection_get_max_message_size(), dbus_connection_get_max_message_unix_fds(), dbus_connection_get_max_received_size(), dbus_connection_get_max_received_unix_fds(), dbus_connection_get_object_path_data(), dbus_connection_get_outgoing_size(), dbus_connection_get_outgoing_unix_fds(), dbus_connection_get_server_id(), dbus_connection_get_socket(), dbus_connection_get_unix_process_id(), dbus_connection_get_unix_user(), dbus_connection_get_windows_user(), dbus_connection_has_messages_to_send(), dbus_connection_list_registered(), dbus_connection_pop_message(), dbus_connection_preallocate_send(), dbus_connection_remove_filter(), dbus_connection_return_message(), dbus_connection_send(), dbus_connection_send_preallocated(), dbus_connection_send_with_reply(), dbus_connection_send_with_reply_and_block(), dbus_connection_set_allow_anonymous(), dbus_connection_set_dispatch_status_function(), dbus_connection_set_exit_on_disconnect(), dbus_connection_set_max_message_size(), dbus_connection_set_max_message_unix_fds(), dbus_connection_set_max_received_size(), dbus_connection_set_max_received_unix_fds(), dbus_connection_set_route_peer_messages(), dbus_connection_set_timeout_functions(), dbus_connection_set_unix_user_function(), dbus_connection_set_wakeup_main_function(), dbus_connection_set_watch_functions(), dbus_connection_set_windows_user_function(), dbus_connection_steal_borrowed_message(), dbus_connection_unregister_object_path(), dbus_pending_call_get_completed(), dbus_pending_call_get_data(), dbus_pending_call_set_data(), dbus_pending_call_set_notify(), and dbus_pending_call_steal_reply().

Function Documentation

void _dbus_pending_call_complete ( DBusPendingCall pending)

Calls notifier function for the pending call and sets the call to completed.

Parameters
pendingthe pending call

Definition at line 204 of file dbus-pending-call.c.

References _dbus_assert, DBusPendingCall::completed, dbus_pending_call_get_data(), DBusPendingCall::function, and TRUE.

dbus_bool_t _dbus_pending_call_get_completed_unlocked ( DBusPendingCall pending)

Checks whether the pending call has received a reply yet, or not.

Assumes connection lock is held.

Parameters
pendingthe pending call
Returns
TRUE if a reply has been received

Definition at line 480 of file dbus-pending-call.c.

References DBusPendingCall::completed.

Referenced by _dbus_connection_block_pending_call(), and _dbus_connection_do_iteration_unlocked().

DBusConnection* _dbus_pending_call_get_connection_and_lock ( DBusPendingCall pending)

Gets the connection associated with this pending call.

Parameters
pendingthe pending_call
Returns
the connection associated with the pending call

Definition at line 323 of file dbus-pending-call.c.

References _dbus_assert, DBusPendingCall::connection, CONNECTION_LOCK, and NULL.

Referenced by _dbus_connection_block_pending_call().

DBusConnection* _dbus_pending_call_get_connection_unlocked ( DBusPendingCall pending)

Gets the connection associated with this pending call.

Parameters
pendingthe pending_call
Returns
the connection associated with the pending call

Definition at line 338 of file dbus-pending-call.c.

References _dbus_assert, DBusPendingCall::connection, and NULL.

dbus_uint32_t _dbus_pending_call_get_reply_serial_unlocked ( DBusPendingCall pending)

Gets the reply's serial number.

Parameters
pendingthe pending_call
Returns
a serial number for the reply or 0

Definition at line 293 of file dbus-pending-call.c.

References _dbus_assert, NULL, and DBusPendingCall::reply_serial.

Referenced by _dbus_connection_block_pending_call(), and _dbus_connection_do_iteration_unlocked().

DBusTimeout* _dbus_pending_call_get_timeout_unlocked ( DBusPendingCall pending)

Retrives the timeout.

Parameters
pendingthe pending_call
Returns
a timeout object or NULL if call has no timeout

Definition at line 279 of file dbus-pending-call.c.

References _dbus_assert, NULL, and DBusPendingCall::timeout.

Referenced by _dbus_connection_block_pending_call(), and _dbus_connection_queue_received_message_link().

dbus_bool_t _dbus_pending_call_is_timeout_added_unlocked ( DBusPendingCall pending)

Checks to see if a timeout has been added.

Parameters
pendingthe pending_call
Returns
TRUE if there is a timeout or FALSE if not

Definition at line 248 of file dbus-pending-call.c.

References _dbus_assert, NULL, and DBusPendingCall::timeout_added.

Referenced by _dbus_connection_queue_received_message_link().

DBusPendingCall* _dbus_pending_call_new_unlocked ( DBusConnection connection,
int  timeout_milliseconds,
DBusTimeoutHandler  timeout_handler 
)

Creates a new pending reply object.

Parameters
connectionconnection where reply will arrive
timeout_millisecondslength of timeout, -1 (or DBUS_TIMEOUT_USE_DEFAULT) for default, DBUS_TIMEOUT_INFINITE for no timeout
timeout_handlertimeout handler, takes pending call as data
Returns
a new DBusPendingCall or NULL if no memory.

Definition at line 109 of file dbus-pending-call.c.

References _dbus_assert, _dbus_atomic_inc(), _dbus_connection_ref_unlocked(), _dbus_data_slot_list_init(), _dbus_timeout_new(), DBusPendingCall::connection, dbus_free(), dbus_new0, dbus_pending_call_allocate_data_slot(), dbus_pending_call_free_data_slot(), DBUS_TIMEOUT_INFINITE, NULL, DBusPendingCall::refcount, DBusPendingCall::slot_list, and DBusPendingCall::timeout.

Referenced by dbus_connection_send_with_reply().

void _dbus_pending_call_queue_timeout_error_unlocked ( DBusPendingCall pending,
DBusConnection connection 
)

If the pending call hasn't been timed out, add its timeout error reply to the connection's incoming message queue.

Parameters
pendingthe pending call
connectionthe connection the call was sent to

Definition at line 228 of file dbus-pending-call.c.

References _dbus_assert, _dbus_connection_queue_synthesized_message_link(), DBusPendingCall::connection, NULL, and DBusPendingCall::timeout_link.

DBusPendingCall* _dbus_pending_call_ref_unlocked ( DBusPendingCall pending)

Increments the reference count on a pending call, while the lock on its connection is already held.

Parameters
pendingthe pending call object
Returns
the pending call object

Definition at line 394 of file dbus-pending-call.c.

References _dbus_atomic_inc(), and DBusPendingCall::refcount.

dbus_bool_t _dbus_pending_call_set_data_unlocked ( DBusPendingCall pending,
dbus_int32_t  slot,
void *  data,
DBusFreeFunction  free_data_func 
)

Stores a pointer on a DBusPendingCall, along with an optional function to be used for freeing the data when the data is set again, or when the pending call is finalized.

The slot number must have been allocated with dbus_pending_call_allocate_data_slot().

Parameters
pendingthe pending_call
slotthe slot number
datathe data to store
free_data_funcfinalizer function for the data
Returns
TRUE if there was enough memory to store the data

Definition at line 502 of file dbus-pending-call.c.

References _dbus_data_slot_list_set(), DBusPendingCall::connection, CONNECTION_LOCK, CONNECTION_UNLOCK, and DBusPendingCall::slot_list.

Referenced by dbus_pending_call_set_data(), and dbus_pending_call_set_notify().

void _dbus_pending_call_set_reply_serial_unlocked ( DBusPendingCall pending,
dbus_uint32_t  serial 
)

Sets the reply's serial number.

Parameters
pendingthe pending_call
serialthe serial number

Definition at line 307 of file dbus-pending-call.c.

References _dbus_assert, NULL, and DBusPendingCall::reply_serial.

Referenced by _dbus_pending_call_set_timeout_error_unlocked().

void _dbus_pending_call_set_reply_unlocked ( DBusPendingCall pending,
DBusMessage message 
)

Sets the reply of a pending call with the given message, or if the message is NULL, by timing out the pending call.

Parameters
pendingthe pending call
messagethe message to complete the call with, or NULL to time out the call

Definition at line 172 of file dbus-pending-call.c.

References _dbus_assert, _dbus_list_clear(), DBusList::data, dbus_message_get_reply_serial(), dbus_message_get_type(), dbus_message_ref(), DBUS_MESSAGE_TYPE_ERROR, DBUS_MESSAGE_TYPE_METHOD_RETURN, NULL, DBusPendingCall::reply, DBusPendingCall::reply_serial, and DBusPendingCall::timeout_link.

void _dbus_pending_call_set_timeout_added_unlocked ( DBusPendingCall pending,
dbus_bool_t  is_added 
)

Sets wether the timeout has been added.

Parameters
pendingthe pending_call
is_addedwhether or not a timeout is added

Definition at line 263 of file dbus-pending-call.c.

References _dbus_assert, NULL, and DBusPendingCall::timeout_added.

Referenced by _dbus_connection_queue_received_message_link().

dbus_bool_t _dbus_pending_call_set_timeout_error_unlocked ( DBusPendingCall pending,
DBusMessage message,
dbus_uint32_t  serial 
)

Sets the reply message associated with the pending call to a timeout error.

Parameters
pendingthe pending_call
messagethe message we are sending the error reply to
serialserial number for the reply
Returns
FALSE on OOM

Definition at line 354 of file dbus-pending-call.c.

References _dbus_list_alloc_link(), _dbus_pending_call_set_reply_serial_unlocked(), DBUS_ERROR_NO_REPLY, dbus_message_new_error(), dbus_message_unref(), FALSE, NULL, DBusPendingCall::timeout_link, and TRUE.

Referenced by dbus_connection_send_with_reply().

void _dbus_pending_call_unref_and_unlock ( DBusPendingCall pending)

Decrements the reference count on a pending call, freeing it if the count reaches 0.

Assumes connection lock is already held.

Parameters
pendingthe pending call object

Definition at line 457 of file dbus-pending-call.c.

References _dbus_assert, _dbus_atomic_dec(), DBusPendingCall::connection, CONNECTION_UNLOCK, and DBusPendingCall::refcount.