Gio::AsyncInitable Class Reference

AsyncInitable - Asynchronously failable object initialization interface. More...

#include <giomm/asyncinitable.h>

Inheritance diagram for Gio::AsyncInitable:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~AsyncInitable ()
GAsyncInitable* gobj ()
 Provides access to the underlying C GObject.
const GAsyncInitable* gobj () const
 Provides access to the underlying C GObject.

Static Public Member Functions

static void add_interface (GType gtype_implementer)

Protected Member Functions

void init_async (const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
 Starts asynchronous initialization of the object implementing the interface.
void init_async (const SlotAsyncReady& slot, int io_priority=Glib::PRIORITY_DEFAULT)
 Starts asynchronous initialization of the object implementing the interface.
bool init_finish (const Glib::RefPtr< AsyncResult >& result)
 Finishes asynchronous initialization and returns the result.
virtual void init_async_vfunc (const SlotAsyncReady& slot, const Glib::RefPtr< Cancellable >& cancellable, int io_priority=Glib::PRIORITY_DEFAULT)
virtual bool init_finish_vfunc (const Glib::RefPtr< AsyncResult >& res)

Related Functions

(Note that these are not member functions.)



Glib::RefPtr< Gio::AsyncInitablewrap (GAsyncInitable* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

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 NULL and a set GError on failure.


Constructor & Destructor Documentation

virtual Gio::AsyncInitable::~AsyncInitable (  )  [virtual]

Member Function Documentation

static void Gio::AsyncInitable::add_interface ( GType  gtype_implementer  )  [static]
const GAsyncInitable* Gio::AsyncInitable::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gio::DBusConnection, and Gio::DBusProxy.

GAsyncInitable* Gio::AsyncInitable::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Reimplemented in Gio::DBusConnection, and Gio::DBusProxy.

void Gio::AsyncInitable::init_async ( const SlotAsyncReady slot,
int  io_priority = Glib::PRIORITY_DEFAULT 
) [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, slot will be called. You can then call init_finish() to get the result of the initialization.

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.

Parameters:
io_priority The I/O priority of the operation.
slot a SlotAsyncReady to call when the request is satisfied.
Since glibmm 2.26:
void Gio::AsyncInitable::init_async ( const SlotAsyncReady slot,
const Glib::RefPtr< Cancellable >&  cancellable,
int  io_priority = Glib::PRIORITY_DEFAULT 
) [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, 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 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.

Parameters:
io_priority The I/O priority of the operation.
cancellable Cancellable object to make cancellation possible.
slot a SlotAsyncReady to call when the request is satisfied.
Since glibmm 2.26:
virtual void Gio::AsyncInitable::init_async_vfunc ( const SlotAsyncReady slot,
const Glib::RefPtr< Cancellable >&  cancellable,
int  io_priority = Glib::PRIORITY_DEFAULT 
) [protected, virtual]
bool Gio::AsyncInitable::init_finish ( const Glib::RefPtr< AsyncResult >&  result  )  [protected]

Finishes asynchronous initialization and returns the result.

See g_async_initable_init_async().

Since glibmm 2.22:
Parameters:
res A AsyncResult.
Returns:
true if successful. If an error has occurred, this function will return false and set error appropriately if present.
virtual bool Gio::AsyncInitable::init_finish_vfunc ( const Glib::RefPtr< AsyncResult >&  res  )  [protected, virtual]
Exceptions:
Glib::Errror. 

Friends And Related Function Documentation

Glib::RefPtr< Gio::AsyncInitable > wrap ( GAsyncInitable *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
object The C instance.
take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.
Generated on Sun Sep 19 21:30:34 2010 for glibmm by  doxygen 1.6.3