1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
/* Copyright (C) 2010 The giomm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#include <glibmm/interface.h>
#include <glibmm/priorities.h>
#include <giomm/asyncresult.h>
_DEFS(giomm,gio)
_PINCLUDE(glibmm/private/interface_p.h)
_PINCLUDE(gio/gio.h)
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GAsyncInitableIface GAsyncInitableIface;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gio
{
class GIOMM_API Cancellable;
/** AsyncInitable - Asynchronously failable object initialization interface.
* This is the asynchronous version of Initable; it behaves the same in all
* ways except that initialization is asynchronous. For more details see the
* descriptions on Initable.
*
* A class may implement both the Initable and AsyncInitable interfaces.
*
* Users of objects implementing this are not intended to use the interface
* method directly; instead it will be used automatically in various ways. For
* C applications you generally just call g_async_initable_new_async()
* directly, or indirectly via a foo_thing_new_async() wrapper. This will call
* g_async_initable_init_async() under the cover, calling back with nullptr and a
* set GError on failure.
*/
class GIOMM_API AsyncInitable : public Glib::Interface
{
_CLASS_INTERFACE(AsyncInitable, GAsyncInitable, G_ASYNC_INITABLE, GAsyncInitableIface, , , GIOMM_API)
protected:
/** Starts asynchronous initialization of the object implementing the
* interface. This must be done before any real use of the object after
* initial construction. If the object also implements Initable you can
* optionally call Gio::Initable::init() instead.
*
* When the initialization is finished, @a slot will be called. You can
* then call init_finish() to get the result of the initialization.
*
* Implementations may also support cancellation. Initialization can be
* cancelled by triggering the @a cancellable object from another thread. If
* the operation was cancelled, the error Gio::IO_ERROR_CANCELLED will be
* returned. If the object doesn't support cancellable initialization, the
* error Gio::IO_ERROR_NOT_SUPPORTED will be returned.
*
* If this function is not called, or returns with an error, then all
* operations on the object should fail, generally returning the error
* Gio::IO_ERROR_NOT_INITIALIZED.
*
* Implementations of this method must be idempotent: i.e. multiple calls to
* this function with the same argument should return the same results. Only
* the first call initializes the object; further calls return the result of
* the first call. This is so that it's safe to implement the singleton
* pattern in the GObject constructor function.
*
* For classes that also support the Initable interface, the default
* implementation of this method will run the Gio::Initable::init() method
* in a thread, so if you want to support asynchronous initialization via
* threads, just implement the AsyncInitable interface without overriding
* any interface methods.
*
* @param io_priority The I/O priority of the operation.
* @param cancellable Cancellable object to make cancellation possible.
* @param slot a SlotAsyncReady to call when the request is satisfied.
*
* @newin{2,28}
*/
void init_async(const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable,
int io_priority = Glib::PRIORITY_DEFAULT);
_IGNORE(g_async_initable_init_async)
/// Non-cancellable version of init_async().
void init_async(const SlotAsyncReady& slot,
int io_priority = Glib::PRIORITY_DEFAULT);
_WRAP_METHOD(bool init_finish(const Glib::RefPtr<AsyncResult>& res), g_async_initable_init_finish, errthrow)
_WRAP_METHOD(Glib::RefPtr<Glib::Object> create_finish(const Glib::RefPtr<AsyncResult>& res), g_async_initable_new_finish, errthrow)
virtual void init_async_vfunc(const SlotAsyncReady& slot,
const Glib::RefPtr<Cancellable>& cancellable,
int io_priority = Glib::PRIORITY_DEFAULT);
/** @throw Glib::Errror.
*/
virtual bool init_finish_vfunc(const Glib::RefPtr<AsyncResult>& res);
protected:
#m4begin
_PUSH(SECTION_PCC_CLASS_INIT_VFUNCS)
klass->init_async = &AsyncInitable_init_async_vfunc_c_callback;
klass->init_finish = &AsyncInitable_init_finish_vfunc_c_callback;
AsyncInitable_init_async_vfunc_funcptr = &init_async_vfunc_callback;
AsyncInitable_init_finish_vfunc_funcptr = &init_finish_vfunc_callback;
_SECTION(SECTION_PH_VFUNCS)
static void init_async_vfunc_callback(GAsyncInitable* self,
int io_priority, GCancellable* cancellable, GAsyncReadyCallback callback,
gpointer user_data);
static gboolean init_finish_vfunc_callback(GAsyncInitable* self,
GAsyncResult* res, GError** error);
_POP()
#m4end
};
} // namespace Gio
|
