D-Bus  1.9.2
Macros | Typedefs | Functions

Pending reply to a method call message. More...

Macros

#define DBUS_TIMEOUT_INFINITE   ((int) 0x7fffffff)
 An integer constant representing an infinite timeout. More...
 
#define DBUS_TIMEOUT_USE_DEFAULT   (-1)
 An integer constant representing a request to use the default timeout. More...
 

Typedefs

typedef struct DBusPendingCall DBusPendingCall
 Opaque type representing a method call that has not yet received a reply. More...
 

Functions

DBusPendingCalldbus_pending_call_ref (DBusPendingCall *pending)
 Increments the reference count on a pending call. More...
 
void dbus_pending_call_unref (DBusPendingCall *pending)
 Decrements the reference count on a pending call, freeing it if the count reaches 0. More...
 
dbus_bool_t dbus_pending_call_set_notify (DBusPendingCall *pending, DBusPendingCallNotifyFunction function, void *user_data, DBusFreeFunction free_user_data)
 Sets a notification function to be called when the reply is received or the pending call times out. More...
 
void dbus_pending_call_cancel (DBusPendingCall *pending)
 Cancels the pending call, such that any reply or error received will just be ignored. More...
 
dbus_bool_t dbus_pending_call_get_completed (DBusPendingCall *pending)
 Checks whether the pending call has received a reply yet, or not. More...
 
DBusMessagedbus_pending_call_steal_reply (DBusPendingCall *pending)
 Gets the reply, or returns NULL if none has been received yet. More...
 
void dbus_pending_call_block (DBusPendingCall *pending)
 Block until the pending call is completed. More...
 
dbus_bool_t dbus_pending_call_allocate_data_slot (dbus_int32_t *slot_p)
 Allocates an integer ID to be used for storing application-specific data on any DBusPendingCall. More...
 
void dbus_pending_call_free_data_slot (dbus_int32_t *slot_p)
 Deallocates a global ID for DBusPendingCall data slots. More...
 
dbus_bool_t dbus_pending_call_set_data (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...
 
void * dbus_pending_call_get_data (DBusPendingCall *pending, dbus_int32_t slot)
 Retrieves data previously set with dbus_pending_call_set_data(). More...
 

Detailed Description

Pending reply to a method call message.

A DBusPendingCall is an object representing an expected reply. A DBusPendingCall can be created when you send a message that should have a reply.

Macro Definition Documentation

#define DBUS_TIMEOUT_INFINITE   ((int) 0x7fffffff)

An integer constant representing an infinite timeout.

This has the numeric value 0x7fffffff (the largest 32-bit signed integer).

For source compatibility with D-Bus versions earlier than 1.4.12, use 0x7fffffff, or INT32_MAX (assuming your platform has it).

Definition at line 41 of file dbus-pending-call.h.

Referenced by _dbus_pending_call_new_unlocked().

#define DBUS_TIMEOUT_USE_DEFAULT   (-1)

An integer constant representing a request to use the default timeout.

This has numeric value -1.

For source compatibility with D-Bus versions earlier than 1.4.12, use a literal -1.

Definition at line 42 of file dbus-pending-call.h.

Typedef Documentation

Opaque type representing a method call that has not yet received a reply.

Opaque data type representing a message pending.

Definition at line 49 of file dbus-connection.h.

Function Documentation

DBUS_EXPORT dbus_bool_t dbus_pending_call_allocate_data_slot ( dbus_int32_t *  slot_p)

Allocates an integer ID to be used for storing application-specific data on any DBusPendingCall.

The allocated ID may then be used with dbus_pending_call_set_data() and dbus_pending_call_get_data(). The passed-in slot must be initialized to -1, and is filled in with the slot ID. If the passed-in slot is not -1, it's assumed to be already allocated, and its refcount is incremented.

The allocated slot is global, i.e. all DBusPendingCall objects will have a slot with the given integer ID reserved.

Parameters
slot_paddress of a global variable storing the slot
Returns
FALSE on failure (no memory)

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

References _dbus_data_slot_allocator_alloc(), FALSE, and NULL.

Referenced by _dbus_pending_call_new_unlocked().

DBUS_EXPORT void dbus_pending_call_block ( DBusPendingCall pending)

Block until the pending call is completed.

The blocking is as with dbus_connection_send_with_reply_and_block(); it does not enter the main loop or process other messages, it simply waits for the reply in question.

If the pending call is already completed, this function returns immediately.

Todo:
when you start blocking, the timeout is reset, but it should really only use time remaining since the pending call was created. This requires storing timestamps instead of intervals in the timeout
Parameters
pendingthe pending call

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

References _dbus_connection_block_pending_call(), and NULL.

Referenced by dbus_connection_send_with_reply_and_block().

DBUS_EXPORT void dbus_pending_call_cancel ( DBusPendingCall pending)

Cancels the pending call, such that any reply or error received will just be ignored.

Drops the dbus library's internal reference to the DBusPendingCall so will free the call if nobody else is holding a reference. However you usually get a reference from dbus_connection_send_with_reply() so probably your app owns a ref also.

Note that canceling a pending call will not simulate a timed-out call; if a call times out, then a timeout error reply is received. If you cancel the call, no reply is received unless the the reply was already received before you canceled.

Parameters
pendingthe pending call

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

References _dbus_connection_remove_pending_call(), connection, and NULL.

DBUS_EXPORT void dbus_pending_call_free_data_slot ( dbus_int32_t *  slot_p)

Deallocates a global ID for DBusPendingCall data slots.

dbus_pending_call_get_data() and dbus_pending_call_set_data() may no longer be used with this slot. Existing data stored on existing DBusPendingCall objects will be freed when the DBusPendingCall is finalized, but may not be retrieved (and may only be replaced if someone else reallocates the slot). When the refcount on the passed-in slot reaches 0, it is set to -1.

Parameters
slot_paddress storing the slot to deallocate

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

References _dbus_data_slot_allocator_free(), and NULL.

Referenced by _dbus_pending_call_new_unlocked().

DBUS_EXPORT dbus_bool_t dbus_pending_call_get_completed ( DBusPendingCall pending)

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

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

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

References completed, connection, CONNECTION_LOCK, CONNECTION_UNLOCK, FALSE, and NULL.

Referenced by _dbus_connection_block_pending_call().

DBUS_EXPORT void * dbus_pending_call_get_data ( DBusPendingCall pending,
dbus_int32_t  slot 
)

Retrieves data previously set with dbus_pending_call_set_data().

The slot must still be allocated (must not have been freed).

Parameters
pendingthe pending_call
slotthe slot to get data from
Returns
the data, or NULL if not found

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

References _dbus_data_slot_list_get(), connection, CONNECTION_LOCK, CONNECTION_UNLOCK, NULL, and slot_list.

Referenced by _dbus_pending_call_complete().

DBUS_EXPORT DBusPendingCall * dbus_pending_call_ref ( DBusPendingCall pending)

Increments the reference count on a pending call.

Parameters
pendingthe pending call object
Returns
the pending call object

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

References _dbus_atomic_inc(), NULL, and refcount.

Referenced by _dbus_connection_block_pending_call().

DBUS_EXPORT dbus_bool_t dbus_pending_call_set_data ( 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 801 of file dbus-pending-call.c.

References _dbus_pending_call_set_data_unlocked(), connection, CONNECTION_LOCK, CONNECTION_UNLOCK, FALSE, and NULL.

DBUS_EXPORT dbus_bool_t dbus_pending_call_set_notify ( DBusPendingCall pending,
DBusPendingCallNotifyFunction  function,
void *  user_data,
DBusFreeFunction  free_user_data 
)

Sets a notification function to be called when the reply is received or the pending call times out.

Parameters
pendingthe pending call
functionnotifier function
user_datadata to pass to notifier function
free_user_datafunction to free the user data
Returns
FALSE if not enough memory

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

References _dbus_pending_call_set_data_unlocked(), connection, CONNECTION_LOCK, CONNECTION_UNLOCK, FALSE, function, NULL, and TRUE.

DBUS_EXPORT DBusMessage * dbus_pending_call_steal_reply ( DBusPendingCall pending)

Gets the reply, or returns NULL if none has been received yet.

Ownership of the reply message passes to the caller. This function can only be called once per pending call, since the reply message is tranferred to the caller.

Parameters
pendingthe pending call
Returns
the reply message or NULL.

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

References completed, connection, CONNECTION_LOCK, CONNECTION_UNLOCK, NULL, and reply.

Referenced by dbus_connection_send_with_reply_and_block().

DBUS_EXPORT void dbus_pending_call_unref ( DBusPendingCall pending)

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

Parameters
pendingthe pending call object

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

References _dbus_atomic_dec(), NULL, and refcount.

Referenced by _dbus_connection_block_pending_call(), dbus_connection_send_with_reply(), and dbus_connection_send_with_reply_and_block().