Future

Object Hierarchy:

Description:

[ GenericAccessors ]
public interface Future<G> : Object

Future is a value which might not yet be computed - for example it is calculated in different thread or depends on I/O value.

All methods can be called from many threads as part of interface.

Note:

Statement that call does not block does not mean that it is lock-free. Internally the implementation is allowed to take mutex but it should guarantee that it is not for a long time (including blocking on anything else, I/O calls or callbacks).

Since:

0.11.0

Content:

Properties:

public abstract Error? exception { get; }
Checks the exception that have been set. I.e. if the computation has thrown the exception it should be set here and the wait, wait_until and wait_async should throw FutureError.EXCEPTION.
public abstract bool ready { get; }
Checks if value is ready. If it is calls to wait and wait_until will not block and value is returned immediately.
public virtual G value { get; }
The value associated with Future. If value is not ready getting value will block until value is ready.

Delegates:

public delegate Future<A> FlatMapFunc<A,G> (G value)
public delegate unowned A LightMapFunc<A,G> (G value)
public delegate A MapFunc<A,G> (G value)
public delegate C ZipFunc<A,B,C> (A a, B b)

Methods:

public virtual Future<A> flat_map<A> (owned FlatMapFunc<A,G> func)
Maps a future value to another future value which is returned (call does not block).
public virtual Future<A> light_map<A> (owned LightMapFunc<A,G> func)
Maps a future value to another value by a function and returns the another value in future.
public virtual Future<A> light_map_broken<A> (LightMapFunc<A,G> func)
public virtual Future<A> map<A> (owned MapFunc<A,G> func)
Maps a future value to another value by a function and returns the another value in future.
public abstract unowned G wait () throws FutureError
Waits until the value is ready.
public abstract async unowned G wait_async () throws FutureError
Reschedules the callback until the value is available.
public abstract bool wait_until (int64 end_time, out unowned G value = null) throws FutureError
Waits until the value is ready or deadline have passed.
public virtual Future<B> zip<A,B> (owned ZipFunc<G,A,B> zip_func, Future<A> second)
Combines values of two futures using a function returning the combined value in future (call does not block).

Inherited Members:

All known members inherited from class GLib.Object