gio/gsimpleasyncresult.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_SIMPLE_ASYNC_RESULT_H__
  24 #define __G_SIMPLE_ASYNC_RESULT_H__
  25
  26 #include <gio/gasyncresult.h>
  27 #include <gio/gcancellable.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define G_TYPE_SIMPLE_ASYNC_RESULT         (g_simple_async_result_get_type ())
  32 #define G_SIMPLE_ASYNC_RESULT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_SIMPLE_ASYNC_RESULT, GSimpleAsyncResult))
  33 #define G_SIMPLE_ASYNC_RESULT_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_SIMPLE_ASYNC_RESULT, GSimpleAsyncResultClass))
  34 #define G_IS_SIMPLE_ASYNC_RESULT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_SIMPLE_ASYNC_RESULT))
  35 #define G_IS_SIMPLE_ASYNC_RESULT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_SIMPLE_ASYNC_RESULT))
  36 #define G_SIMPLE_ASYNC_RESULT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_SIMPLE_ASYNC_RESULT, GSimpleAsyncResultClass))
  37
  38 /**
  39  * GSimpleAsyncResult:
  40  *
  41  * A simple implementation of #GAsyncResult.
  42  **/
  43 typedef struct _GSimpleAsyncResult        GSimpleAsyncResult;
  44 typedef struct _GSimpleAsyncResultClass   GSimpleAsyncResultClass;
  45
  46 /**
  47  * GSimpleAsyncThreadFunc:
  48  * @res: a #GSimpleAsyncResult.
  49  * @object: a #GObject.
  50  * @cancellable: optional #GCancellable object, %NULL to ignore.
  51  *
  52  * Simple thread function that runs an asynchronous operation and
  53  * checks for cancellation.
  54  **/
  55 typedef void (*GSimpleAsyncThreadFunc) (GSimpleAsyncResult *res,
  56                                         GObject *object,
  57                                         GCancellable *cancellable);
  58
  59
  60 GType g_simple_async_result_get_type (void) G_GNUC_CONST;
  61
  62 GSimpleAsyncResult *g_simple_async_result_new              (GObject                 *source_object,
  63                                                             GAsyncReadyCallback      callback,
  64                                                             gpointer                 user_data,
  65                                                             gpointer                 source_tag);
  66 GSimpleAsyncResult *g_simple_async_result_new_error        (GObject                 *source_object,
  67                                                             GAsyncReadyCallback      callback,
  68                                                             gpointer                 user_data,
  69                                                             GQuark                   domain,
  70                                                             gint                     code,
  71                                                             const char              *format,
  72                                                             ...) G_GNUC_PRINTF (6, 7);
  73 GSimpleAsyncResult *g_simple_async_result_new_from_error   (GObject                 *source_object,
  74                                                             GAsyncReadyCallback      callback,
  75                                                             gpointer                 user_data,
  76                                                             GError                  *error);
  77
  78 void                g_simple_async_result_set_op_res_gpointer (GSimpleAsyncResult      *simple,
  79                                                                gpointer                 op_res,
  80                                                                GDestroyNotify           destroy_op_res);
  81 gpointer            g_simple_async_result_get_op_res_gpointer (GSimpleAsyncResult      *simple);
  82
  83 void                g_simple_async_result_set_op_res_gssize   (GSimpleAsyncResult      *simple,
  84                                                                gssize                   op_res);
  85 gssize              g_simple_async_result_get_op_res_gssize   (GSimpleAsyncResult      *simple);
  86
  87 void                g_simple_async_result_set_op_res_gboolean (GSimpleAsyncResult      *simple,
  88                                                                gboolean                 op_res);
  89 gboolean            g_simple_async_result_get_op_res_gboolean (GSimpleAsyncResult      *simple);
  90
  91
  92
  93 gpointer            g_simple_async_result_get_source_tag   (GSimpleAsyncResult      *simple);
  94 void                g_simple_async_result_set_handle_cancellation (GSimpleAsyncResult      *simple,
  95                                                                    gboolean          handle_cancellation);
  96 void                g_simple_async_result_complete         (GSimpleAsyncResult      *simple);
  97 void                g_simple_async_result_complete_in_idle (GSimpleAsyncResult      *simple);
  98 void                g_simple_async_result_run_in_thread    (GSimpleAsyncResult      *simple,
  99                                                             GSimpleAsyncThreadFunc   func,
 100                                                             int                      io_priority,
 101                                                             GCancellable            *cancellable);
 102 void                g_simple_async_result_set_from_error   (GSimpleAsyncResult      *simple,
 103                                                             GError                  *error);
 104 gboolean            g_simple_async_result_propagate_error  (GSimpleAsyncResult      *simple,
 105                                                             GError                 **dest);
 106 void                g_simple_async_result_set_error        (GSimpleAsyncResult      *simple,
 107                                                             GQuark                   domain,
 108                                                             gint                     code,
 109                                                             const char              *format,
 110                                                             ...) G_GNUC_PRINTF (4, 5);
 111 void                g_simple_async_result_set_error_va     (GSimpleAsyncResult      *simple,
 112                                                             GQuark                   domain,
 113                                                             gint                     code,
 114                                                             const char              *format,
 115                                                             va_list                  args);
 116
 117 void g_simple_async_report_error_in_idle (GObject *object,
 118                                           GAsyncReadyCallback callback,
 119                                           gpointer user_data,
 120                                           GQuark         domain,
 121                                           gint           code,
 122                                           const char    *format,
 123                                           ...);
 124
 125 G_END_DECLS
 126
 127
 128
 129 #endif /* __G_SIMPLE_ASYNC_RESULT_H__ */