gio/gasyncresult.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this library; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_ASYNC_RESULT_H__
  24 #define __G_ASYNC_RESULT_H__
  25
  26 #include <glib-object.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define G_TYPE_ASYNC_RESULT            (g_async_result_get_type ())
  31 #define G_ASYNC_RESULT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_ASYNC_RESULT, GAsyncResult))
  32 #define G_IS_ASYNC_RESULT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_ASYNC_RESULT))
  33 #define G_ASYNC_RESULT_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_ASYNC_RESULT, GAsyncResultIface))
  34
  35 /**
  36  * GAsyncResult:
  37  *
  38  * Holds results information for an asynchronous operation,
  39  * usually passed directly to a asynchronous _finish() operation.
  40  **/
  41 typedef struct _GAsyncResult         GAsyncResult; /* Dummy typedef */
  42 typedef struct _GAsyncResultIface    GAsyncResultIface;
  43
  44 /**
  45  * GAsyncReadyCallback:
  46  * @source_object: the object the asynchronous operation was started with.
  47  * @res: a #GAsyncResult.
  48  * @user_data: user data passed to the callback.
  49  *
  50  * Type definition for a function that will be called back when an asynchronous
  51  * operation within GIO has been completed.
  52  **/
  53 typedef void (*GAsyncReadyCallback) (GObject *source_object,
  54                                      GAsyncResult *res,
  55                                      gpointer user_data);
  56
  57 /**
  58  * GAsyncResultIface:
  59  * @g_iface: The parent interface.
  60  * @get_user_data: Gets the user data passed to the callback.
  61  * @get_source_object: Gets the source object that issued the asynchronous operation.
  62  *
  63  * Interface definition for #GAsyncResult.
  64  **/
  65 struct _GAsyncResultIface
  66 {
  67   GTypeInterface g_iface;
  68
  69   /* Virtual Table */
  70
  71   gpointer   (*get_user_data)      (GAsyncResult                *async_result);
  72   GObject *  (*get_source_object)  (GAsyncResult                *async_result);
  73 };
  74
  75 GType g_async_result_get_type (void) G_GNUC_CONST;
  76
  77 gpointer g_async_result_get_user_data     (GAsyncResult *res);
  78 GObject *g_async_result_get_source_object (GAsyncResult *res);
  79
  80 G_END_DECLS
  81
  82 #endif /* __G_ASYNC_RESULT_H__ */