2019-02-14 08:37:02 -08:00
|
|
|
abstract @beta Efl.Loop_Consumer extends Efl.Object
|
2016-05-05 16:18:18 -07:00
|
|
|
{
|
2019-01-30 07:16:37 -08:00
|
|
|
[[An @Efl.Loop_Consumer is a class which requires one of the parents to provide
|
|
|
|
an @Efl.Loop interface when performing @Efl.Object.provider_find. It will enforce this by
|
2018-12-14 12:18:16 -08:00
|
|
|
only allowing parents which provide such an interface or $NULL.]]
|
2016-10-05 18:19:25 -07:00
|
|
|
eo_prefix: efl_loop;
|
2016-05-05 16:18:18 -07:00
|
|
|
methods {
|
2016-12-12 20:38:16 -08:00
|
|
|
@property loop {
|
|
|
|
[[The loop to which this object belongs to.]]
|
|
|
|
get {
|
docs: Fix typos and some wrong expressions in Ecore, Ecore_Audio, Ecore_Cocoa, Ecore_Con, and Ector API reference doxygen.
Summary: I had fixed some typos and wrong expressions, such as capital letters, $simbols in .eo and singulars in Ecore, Ecore_Audio, Ecore_Cocoa, Ecore_Con, and Ector API reference doxygen.
Test Plan: Doxygen Revision
Reviewers: Jaehyun_Cho, stefan, jpeg, cedric, raster
Reviewed By: Jaehyun_Cho
Differential Revision: https://phab.enlightenment.org/D4943
2017-06-06 21:01:13 -07:00
|
|
|
[[Gets a handle to the loop.]]
|
2016-12-12 20:38:16 -08:00
|
|
|
}
|
|
|
|
values {
|
|
|
|
loop: Efl.Loop; [[Efl loop]]
|
|
|
|
}
|
2016-05-05 16:18:18 -07:00
|
|
|
}
|
2018-12-14 12:18:16 -08:00
|
|
|
future_resolved @const {
|
|
|
|
[[Creates a new future that is already resolved to a value.
|
|
|
|
|
|
|
|
This function creates a new future with an already known value,
|
|
|
|
that will be resolved and dispatched by the loop scheduler as
|
|
|
|
usual.
|
|
|
|
|
|
|
|
This is a helper that behaves the same as eina_future_resolved.]]
|
2018-11-22 17:11:54 -08:00
|
|
|
params {
|
2018-12-14 12:18:16 -08:00
|
|
|
result: any_value; [[The value to be delivered.
|
|
|
|
|
2019-01-18 05:34:04 -08:00
|
|
|
Note that the value contents must survive this function scope, that is, do
|
2018-12-14 12:18:16 -08:00
|
|
|
not use stack allocated blobs, arrays, structures or types that keep
|
|
|
|
references to memory you give. Values will be automatically cleaned up using
|
|
|
|
\@ref eina_value_flush() once they are unused (no more future or futures returned a new value)]]
|
2018-11-22 17:11:54 -08:00
|
|
|
}
|
2018-12-14 12:18:16 -08:00
|
|
|
return: future<any_value>; [[The future or $NULL on error.]]
|
2018-11-22 17:11:54 -08:00
|
|
|
}
|
2018-12-14 12:18:16 -08:00
|
|
|
future_rejected @const {
|
|
|
|
[[Creates a new future that is already rejected to a specified error using the @.loop.get.
|
|
|
|
|
|
|
|
This function creates a new future with an already known error,
|
|
|
|
that will be resolved and dispatched by the loop scheduler as
|
|
|
|
usual.
|
|
|
|
|
|
|
|
This is a helper that behaves the same as \@ref eina_future_rejected.]]
|
2018-11-22 17:11:54 -08:00
|
|
|
params {
|
2018-12-14 12:18:16 -08:00
|
|
|
error: Eina.Error; [[An Eina_Error value]]
|
2018-11-22 17:11:54 -08:00
|
|
|
}
|
2018-12-14 12:18:16 -08:00
|
|
|
return: future<Eina.Error>; [[The future or $NULL on error.]]
|
2018-11-22 17:11:54 -08:00
|
|
|
}
|
2019-01-04 16:00:21 -08:00
|
|
|
promise_new @const {
|
2018-12-26 09:47:47 -08:00
|
|
|
[[Create a new promise with the scheduler coming from the loop provided by this object.
|
|
|
|
|
|
|
|
Note: You should not use eina_promise_data_set as this function rely on controlling the promise data.]]
|
|
|
|
return: ptr(Eina.Promise) @owned; [[The new promise.]]
|
|
|
|
}
|
2016-05-05 16:18:18 -07:00
|
|
|
}
|
|
|
|
implements {
|
2016-12-27 07:19:06 -08:00
|
|
|
Efl.Object.parent { set; }
|
2016-05-05 16:18:18 -07:00
|
|
|
}
|
2016-10-05 18:19:25 -07:00
|
|
|
}
|