/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */

/* dbus-pending-call.h Object representing a call in progress.

 *

 * Copyright (C) 2002, 2003 Red Hat Inc.

 *

 * Licensed under the Academic Free License version 2.1

 * 

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

 *

 */

#if !defined (DBUS_INSIDE_DBUS_H) && !defined (DBUS_COMPILATION)

#error "Only <dbus/dbus.h> can be included directly, this file may disappear or change contents."

#endif

#ifndef DBUS_PENDING_CALL_H

#define DBUS_PENDING_CALL_H

#include <dbus/dbus-macros.h>

#include <dbus/dbus-types.h>

#include <dbus/dbus-connection.h>

DBUS_BEGIN_DECLS

/**

 * @addtogroup DBusPendingCall

 * @{

 */

#define DBUS_TIMEOUT_INFINITE ((int) 0x7fffffff)

#define DBUS_TIMEOUT_USE_DEFAULT (-1)

DBUS_EXPORT

DBusPendingCall* dbus_pending_call_ref       (DBusPendingCall               *pending);

DBUS_EXPORT

void         dbus_pending_call_unref         (DBusPendingCall               *pending);

DBUS_EXPORT

dbus_bool_t  dbus_pending_call_set_notify    (DBusPendingCall               *pending,

                                              DBusPendingCallNotifyFunction  function,

                                              void                          *user_data,

                                              DBusFreeFunction               free_user_data);

DBUS_EXPORT

void         dbus_pending_call_cancel        (DBusPendingCall               *pending);

DBUS_EXPORT

dbus_bool_t  dbus_pending_call_get_completed (DBusPendingCall               *pending);

DBUS_EXPORT

DBusMessage* dbus_pending_call_steal_reply   (DBusPendingCall               *pending);

DBUS_EXPORT

void         dbus_pending_call_block         (DBusPendingCall               *pending);

DBUS_EXPORT

dbus_bool_t dbus_pending_call_allocate_data_slot (dbus_int32_t     *slot_p);

DBUS_EXPORT

void        dbus_pending_call_free_data_slot     (dbus_int32_t     *slot_p);

DBUS_EXPORT

dbus_bool_t dbus_pending_call_set_data           (DBusPendingCall  *pending,

                                                  dbus_int32_t      slot,

                                                  void             *data,

                                                  DBusFreeFunction  free_data_func);

DBUS_EXPORT

void*       dbus_pending_call_get_data           (DBusPendingCall  *pending,

                                                  dbus_int32_t      slot);

/**

 * Clear a variable or struct member that contains a #DBusPendingCall.

 * If it does not contain #NULL, the pending call that was previously

 * there is unreferenced with dbus_pending_call_unref().

 *

 * This is very similar to dbus_clear_connection(): see that function

 * for more details.

 *

 * @param pointer_to_pending_call A pointer to a variable or struct member.

 * pointer_to_pending_call must not be #NULL, but *pointer_to_pending_call

 * may be #NULL.

 */

static inline void

dbus_clear_pending_call (DBusPendingCall **pointer_to_pending_call)

{

  _dbus_clear_pointer_impl (DBusPendingCall, pointer_to_pending_call,

                            dbus_pending_call_unref);

}

/** @} */

DBUS_END_DECLS

#endif /* DBUS_PENDING_CALL_H */