Merge branch 'dbus-1.2'
[platform/upstream/dbus.git] / dbus / 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
36 /**
37  * @addtogroup DBusPendingCall
38  * @{
39  */
40
41 DBUS_EXPORT
42 DBusPendingCall* dbus_pending_call_ref       (DBusPendingCall               *pending);
43 DBUS_EXPORT
44 void         dbus_pending_call_unref         (DBusPendingCall               *pending);
45 DBUS_EXPORT
46 dbus_bool_t  dbus_pending_call_set_notify    (DBusPendingCall               *pending,
47                                               DBusPendingCallNotifyFunction  function,
48                                               void                          *user_data,
49                                               DBusFreeFunction               free_user_data);
50 DBUS_EXPORT
51 void         dbus_pending_call_cancel        (DBusPendingCall               *pending);
52 DBUS_EXPORT
53 dbus_bool_t  dbus_pending_call_get_completed (DBusPendingCall               *pending);
54 DBUS_EXPORT
55 DBusMessage* dbus_pending_call_steal_reply   (DBusPendingCall               *pending);
56 DBUS_EXPORT
57 void         dbus_pending_call_block         (DBusPendingCall               *pending);
58
59 DBUS_EXPORT
60 dbus_bool_t dbus_pending_call_allocate_data_slot (dbus_int32_t     *slot_p);
61 DBUS_EXPORT
62 void        dbus_pending_call_free_data_slot     (dbus_int32_t     *slot_p);
63 DBUS_EXPORT
64 dbus_bool_t dbus_pending_call_set_data           (DBusPendingCall  *pending,
65                                                   dbus_int32_t      slot,
66                                                   void             *data,
67                                                   DBusFreeFunction  free_data_func);
68 DBUS_EXPORT
69 void*       dbus_pending_call_get_data           (DBusPendingCall  *pending,
70                                                   dbus_int32_t      slot);
71
72 /** @} */
73
74 DBUS_END_DECLS
75
76 #endif /* DBUS_PENDING_CALL_H */