D-Bus 1.13.18

dbus-pending-call.h
1/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
2/* dbus-pending-call.h Object representing a call in progress.
3 *
4 * Copyright (C) 2002, 2003 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#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)
24#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."
25#endif
26
27#ifndef DBUS_PENDING_CALL_H
28#define DBUS_PENDING_CALL_H
29
30#include <dbus/dbus-macros.h>
31#include <dbus/dbus-types.h>
32#include <dbus/dbus-connection.h>
33
34 DBUS_BEGIN_DECLS
35
41#define DBUS_TIMEOUT_INFINITE ((int) 0x7fffffff)
42#define DBUS_TIMEOUT_USE_DEFAULT (-1)
43
44DBUS_EXPORT
45 DBusPendingCall* dbus_pending_call_ref (DBusPendingCall *pending);
46DBUS_EXPORT
47 void dbus_pending_call_unref (DBusPendingCall *pending);
48DBUS_EXPORT
49 dbus_bool_t dbus_pending_call_set_notify (DBusPendingCall *pending,
50 DBusPendingCallNotifyFunction function,
51 void *user_data,
52 DBusFreeFunction free_user_data);
53DBUS_EXPORT
54 void dbus_pending_call_cancel (DBusPendingCall *pending);
55DBUS_EXPORT
56 dbus_bool_t dbus_pending_call_get_completed (DBusPendingCall *pending);
57DBUS_EXPORT
58 DBusMessage* dbus_pending_call_steal_reply (DBusPendingCall *pending);
59DBUS_EXPORT
60 void dbus_pending_call_block (DBusPendingCall *pending);
61
62DBUS_EXPORT
63 dbus_bool_t dbus_pending_call_allocate_data_slot (dbus_int32_t *slot_p);
64DBUS_EXPORT
65 void dbus_pending_call_free_data_slot (dbus_int32_t *slot_p);
66DBUS_EXPORT
67 dbus_bool_t dbus_pending_call_set_data (DBusPendingCall *pending,
68 dbus_int32_t slot,
69 void *data,
70 DBusFreeFunction free_data_func);
71DBUS_EXPORT
72 void* dbus_pending_call_get_data (DBusPendingCall *pending,
73 dbus_int32_t slot);
74
87 static inline void
88dbus_clear_pending_call (DBusPendingCall **pointer_to_pending_call)
89{
90 _dbus_clear_pointer_impl (DBusPendingCall, pointer_to_pending_call,
91 dbus_pending_call_unref);
92}
93
96 DBUS_END_DECLS
97
98#endif /* DBUS_PENDING_CALL_H */
DBusPendingCallNotifyFunction
void(* DBusPendingCallNotifyFunction)(DBusPendingCall *pending, void *user_data)
Called when a pending call now has a reply available.
Definition: dbus-connection.h:163
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:63
dbus_pending_call_set_notify
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.
Definition: dbus-pending-call.c:649
dbus_pending_call_free_data_slot
void dbus_pending_call_free_data_slot(dbus_int32_t *slot_p)
Deallocates a global ID for DBusPendingCall data slots.
Definition: dbus-pending-call.c:806
dbus_pending_call_ref
DBusPendingCall * dbus_pending_call_ref(DBusPendingCall *pending)
Increments the reference count on a pending call.
Definition: dbus-pending-call.c:604
dbus_pending_call_get_data
void * dbus_pending_call_get_data(DBusPendingCall *pending, dbus_int32_t slot)
Retrieves data previously set with dbus_pending_call_set_data().
Definition: dbus-pending-call.c:854
dbus_pending_call_steal_reply
DBusMessage * dbus_pending_call_steal_reply(DBusPendingCall *pending)
Gets the reply, or returns NULL if none has been received yet.
Definition: dbus-pending-call.c:729
dbus_pending_call_cancel
void dbus_pending_call_cancel(DBusPendingCall *pending)
Cancels the pending call, such that any reply or error received will just be ignored.
Definition: dbus-pending-call.c:690
dbus_pending_call_block
void dbus_pending_call_block(DBusPendingCall *pending)
Block until the pending call is completed.
Definition: dbus-pending-call.c:764
dbus_pending_call_set_data
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 dat...
Definition: dbus-pending-call.c:828
dbus_pending_call_allocate_data_slot
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.
Definition: dbus-pending-call.c:786
dbus_pending_call_get_completed
dbus_bool_t dbus_pending_call_get_completed(DBusPendingCall *pending)
Checks whether the pending call has received a reply yet, or not.
Definition: dbus-pending-call.c:706
dbus_pending_call_unref
void dbus_pending_call_unref(DBusPendingCall *pending)
Decrements the reference count on a pending call, freeing it if the count reaches 0.
Definition: dbus-pending-call.c:624
dbus_bool_t
dbus_uint32_t dbus_bool_t
A boolean, valid values are TRUE and FALSE.
Definition: dbus-types.h:35
DBusMessage
Internals of DBusMessage.
Definition: dbus-message-private.h:100
DBusPendingCall
Implementation details of DBusPendingCall - all fields are private.
Definition: dbus-pending-call.c:63