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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_SIMPLE_ASYNC_RESULT_H__
  28 #define __G_SIMPLE_ASYNC_RESULT_H__
  29
  30 #include <gio/giotypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 #define G_TYPE_SIMPLE_ASYNC_RESULT         (g_simple_async_result_get_type ())
  35 #define G_SIMPLE_ASYNC_RESULT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_SIMPLE_ASYNC_RESULT, GSimpleAsyncResult))
  36 #define G_SIMPLE_ASYNC_RESULT_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_SIMPLE_ASYNC_RESULT, GSimpleAsyncResultClass))
  37 #define G_IS_SIMPLE_ASYNC_RESULT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_SIMPLE_ASYNC_RESULT))
  38 #define G_IS_SIMPLE_ASYNC_RESULT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_SIMPLE_ASYNC_RESULT))
  39 #define G_SIMPLE_ASYNC_RESULT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_SIMPLE_ASYNC_RESULT, GSimpleAsyncResultClass))
  40
  41 /**
  42  * GSimpleAsyncResult:
  43  *
  44  * A simple implementation of #GAsyncResult.
  45  **/
  46 typedef struct _GSimpleAsyncResultClass   GSimpleAsyncResultClass;
  47
  48
  49 GType               g_simple_async_result_get_type         (void) G_GNUC_CONST;
  50
  51 GSimpleAsyncResult *g_simple_async_result_new              (GObject                 *source_object,
  52                                                             GAsyncReadyCallback      callback,
  53                                                             gpointer                 user_data,
  54                                                             gpointer                 source_tag);
  55 GSimpleAsyncResult *g_simple_async_result_new_error        (GObject                 *source_object,
  56                                                             GAsyncReadyCallback      callback,
  57                                                             gpointer                 user_data,
  58                                                             GQuark                   domain,
  59                                                             gint                     code,
  60                                                             const char              *format,
  61                                                             ...) G_GNUC_PRINTF (6, 7);
  62 GSimpleAsyncResult *g_simple_async_result_new_from_error   (GObject                 *source_object,
  63                                                             GAsyncReadyCallback      callback,
  64                                                             gpointer                 user_data,
  65                                                             const GError            *error);
  66 GSimpleAsyncResult *g_simple_async_result_new_take_error   (GObject                 *source_object,
  67                                                             GAsyncReadyCallback      callback,
  68                                                             gpointer                 user_data,
  69                                                             GError                  *error);
  70
  71 void                g_simple_async_result_set_op_res_gpointer (GSimpleAsyncResult      *simple,
  72                                                                gpointer                 op_res,
  73                                                                GDestroyNotify           destroy_op_res);
  74 gpointer            g_simple_async_result_get_op_res_gpointer (GSimpleAsyncResult      *simple);
  75
  76 void                g_simple_async_result_set_op_res_gssize   (GSimpleAsyncResult      *simple,
  77                                                                gssize                   op_res);
  78 gssize              g_simple_async_result_get_op_res_gssize   (GSimpleAsyncResult      *simple);
  79
  80 void                g_simple_async_result_set_op_res_gboolean (GSimpleAsyncResult      *simple,
  81                                                                gboolean                 op_res);
  82 gboolean            g_simple_async_result_get_op_res_gboolean (GSimpleAsyncResult      *simple);
  83
  84
  85
  86 GLIB_AVAILABLE_IN_2_32
  87 void                g_simple_async_result_set_check_cancellable (GSimpleAsyncResult *simple,
  88                                                                  GCancellable       *check_cancellable);
  89 gpointer            g_simple_async_result_get_source_tag   (GSimpleAsyncResult      *simple);
  90 void                g_simple_async_result_set_handle_cancellation (GSimpleAsyncResult      *simple,
  91                                                                    gboolean          handle_cancellation);
  92 void                g_simple_async_result_complete         (GSimpleAsyncResult      *simple);
  93 void                g_simple_async_result_complete_in_idle (GSimpleAsyncResult      *simple);
  94 void                g_simple_async_result_run_in_thread    (GSimpleAsyncResult      *simple,
  95                                                             GSimpleAsyncThreadFunc   func,
  96                                                             int                      io_priority,
  97                                                             GCancellable            *cancellable);
  98 void                g_simple_async_result_set_from_error   (GSimpleAsyncResult      *simple,
  99                                                             const GError            *error);
 100 void                g_simple_async_result_take_error       (GSimpleAsyncResult      *simple,
 101                                                             GError            *error);
 102 gboolean            g_simple_async_result_propagate_error  (GSimpleAsyncResult      *simple,
 103                                                             GError                 **dest);
 104 void                g_simple_async_result_set_error        (GSimpleAsyncResult      *simple,
 105                                                             GQuark                   domain,
 106                                                             gint                     code,
 107                                                             const char              *format,
 108                                                             ...) G_GNUC_PRINTF (4, 5);
 109 void                g_simple_async_result_set_error_va     (GSimpleAsyncResult      *simple,
 110                                                             GQuark                   domain,
 111                                                             gint                     code,
 112                                                             const char              *format,
 113                                                             va_list                  args);
 114 gboolean            g_simple_async_result_is_valid         (GAsyncResult            *result,
 115                                                             GObject                 *source,
 116                                                             gpointer                 source_tag);
 117
 118 void g_simple_async_report_error_in_idle  (GObject            *object,
 119                                            GAsyncReadyCallback callback,
 120                                            gpointer            user_data,
 121                                            GQuark              domain,
 122                                            gint                code,
 123                                            const char         *format,
 124                                            ...);
 125 void g_simple_async_report_gerror_in_idle (GObject            *object,
 126                                            GAsyncReadyCallback callback,
 127                                            gpointer            user_data,
 128                                            const GError       *error);
 129 void g_simple_async_report_take_gerror_in_idle (GObject            *object,
 130                                                 GAsyncReadyCallback callback,
 131                                                 gpointer            user_data,
 132                                                 GError             *error);
 133
 134 G_END_DECLS
 135
 136
 137
 138 #endif /* __G_SIMPLE_ASYNC_RESULT_H__ */