Gio::AsyncInitable Class Reference

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

#include <giomm/asyncinitable.h>

Inheritance diagram for Gio::AsyncInitable:

Public Member Functions
	AsyncInitable (AsyncInitable &&src) noexcept
AsyncInitable &	operator= (AsyncInitable &&src) noexcept
	~AsyncInitable () noexcept override
GAsyncInitable *	gobj ()
	Provides access to the underlying C GObject.
const GAsyncInitable *	gobj () const
	Provides access to the underlying C GObject.
Public Member Functions inherited from Glib::Interface
	Interface ()
	A Default constructor.
	Interface (Interface &&src) noexcept
Interface &	operator= (Interface &&src) noexcept
	Interface (const Glib::Interface_Class &interface_class)
	Called by constructors of derived classes.
	Interface (GObject *castitem)
	Called by constructors of derived classes.
	~Interface () noexcept override
	Interface (const Interface &)=delete
Interface &	operator= (const Interface &)=delete
GObject *	gobj ()
const GObject *	gobj () const
Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete
ObjectBase &	operator= (const ObjectBase &)=delete
void	set_property_value (const Glib::ustring & property_name, const Glib::ValueBase & value)
	You probably want to use a specific property_*() accessor method instead.
void	get_property_value (const Glib::ustring & property_name, Glib::ValueBase & value) const
	You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
void	set_property (const Glib::ustring & property_name, const PropertyType & value)
	You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
void	get_property (const Glib::ustring & property_name, PropertyType & value) const
	You probably want to use a specific property_*() accessor method instead.
template<class PropertyType >
PropertyType	get_property (const Glib::ustring & property_name) const
	You probably want to use a specific property_*() accessor method instead.
sigc::connection	connect_property_changed (const Glib::ustring & property_name, const sigc::slot< void()> &slot)
	You can use the signal_changed() signal of the property proxy instead.
sigc::connection	connect_property_changed (const Glib::ustring & property_name, sigc::slot< void()> &&slot)
	You can use the signal_changed() signal of the property proxy instead.
void	freeze_notify ()
	Increases the freeze count on object.
void	thaw_notify ()
	Reverts the effect of a previous call to freeze_notify().
virtual void	reference () const
	Increment the reference count for this object.
virtual void	unreference () const
	Decrement the reference count for this object.
GObject *	gobj ()
	Provides access to the underlying C GObject.
const GObject *	gobj () const
	Provides access to the underlying C GObject.
GObject *	gobj_copy () const
	Give a ref-ed copy to someone. Use for direct struct access.

Static Public Member Functions
static void	add_interface (GType gtype_implementer)
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

Protected Member Functions
	AsyncInitable ()
	You should derive from this class to use it.
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)
	Non-cancellable version of init_async().
bool	init_finish (const Glib::RefPtr< AsyncResult > &res)
	Finishes asynchronous initialization and returns the result.
Glib::RefPtr< Glib::Object >	create_finish (const Glib::RefPtr< AsyncResult > &res)
	Finishes the async construction for the various g_async_initable_new calls, returning the created object or nullptr on error.
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)
Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()
	This default constructor is called implicitly from the constructor of user-derived classes, even if, for instance, Gtk::Button calls a different ObjectBase constructor.
	ObjectBase (const char *custom_type_name)
	A derived constructor always overrides this choice.
	ObjectBase (const std::type_info &custom_type_info)
	This constructor is a special feature to allow creation of derived types on the fly, without having to use g_object_new() manually.
	ObjectBase (ObjectBase &&src) noexcept
ObjectBase &	operator= (ObjectBase &&src) noexcept
virtual	~ObjectBase () noexcept=0
void	initialize (GObject *castitem)
void	initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gio::AsyncInitable >	wrap (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 nullptr and a set GError on failure.

Constructor & Destructor Documentation

AsyncInitable() [1/2]

Gio::AsyncInitable::AsyncInitable ( )

protected

You should derive from this class to use it.

AsyncInitable() [2/2]

Gio::AsyncInitable::AsyncInitable ( AsyncInitable &&  src )

noexcept

~AsyncInitable()

Gio::AsyncInitable::~AsyncInitable ( )

overridenoexcept

Member Function Documentation

add_interface()

static void Gio::AsyncInitable::add_interface ( GType  gtype_implementer )

static

create_finish()

Glib::RefPtr< Glib::Object > Gio::AsyncInitable::create_finish ( const Glib::RefPtr< AsyncResult > &  res )

protected

Finishes the async construction for the various g_async_initable_new calls, returning the created object or nullptr on error.

Since glibmm 2.22:

Parameters

res	The AsyncResult from the callback.

Returns

A newly created Object, or nullptr on error. Free with Glib::object_unref().

Exceptions

Glib::Error

get_type()

static GType Gio::AsyncInitable::get_type ( )

static

Get the GType for this class, for use with the underlying GObject type system.

gobj() [1/2]

GAsyncInitable * Gio::AsyncInitable::gobj ( )

inline

Provides access to the underlying C GObject.

gobj() [2/2]

const GAsyncInitable * Gio::AsyncInitable::gobj ( ) const

inline

Provides access to the underlying C GObject.

init_async() [1/2]

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.28:

init_async() [2/2]

void Gio::AsyncInitable::init_async ( const SlotAsyncReady &  slot, int  io_priority = Glib::PRIORITY_DEFAULT  )

protected

Non-cancellable version of init_async().

init_async_vfunc()

virtual void Gio::AsyncInitable::init_async_vfunc ( const SlotAsyncReady &  slot, const Glib::RefPtr< Cancellable > &  cancellable, int  io_priority = Glib::PRIORITY_DEFAULT  )

protectedvirtual

init_finish()

bool Gio::AsyncInitable::init_finish ( const Glib::RefPtr< AsyncResult > &  res )

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.

Exceptions

Glib::Error

init_finish_vfunc()

virtual bool Gio::AsyncInitable::init_finish_vfunc ( const Glib::RefPtr< AsyncResult > &  res )

protectedvirtual

Exceptions

Glib::Errror.

operator=()

AsyncInitable & Gio::AsyncInitable::operator= ( AsyncInitable &&  src )

noexcept

Friends And Related Symbol Documentation

wrap()

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.