aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/promise.txt
blob: 20e1931284f5c5ddd25cecba54b006e837ed5690 (plain) (blame)
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
~~Title: Efl.Promise~~
====== Efl.Promise (class) ======

===== Description =====

%%Efl promise class%%

{{page>:develop:api-include:efl:promise:description&nouser&nolink&nodate}}

===== Inheritance =====

 => [[:develop:api:efl:loop_user|Efl.Loop_User]] //(class)// => [[:develop:api:efl:object|Efl.Object]] //(class)//
++++ Inheritance graph |

<graphviz>
digraph hierarchy {
    bgcolor = "transparent"
    size = "6"
    rankdir = "TB"

    node [shape = "box"]
    edge [color = "gray35"]

    efl_promise [fillcolor = "black", label = "Efl.Promise", color = "gray15", fontcolor = "white", style = "filled"]
    efl_loop_user [fillcolor = "gray15", label = "Efl.Loop_User", color = "gray15", fontcolor = "white", style = "filled"]
    efl_object [fillcolor = "gray15", label = "Efl.Object", color = "gray15", fontcolor = "white", style = "filled"]

    efl_promise -> efl_loop_user
    efl_loop_user -> efl_object
}
</graphviz>

++++

++++ Full hierarchy |

  * [[:develop:api:efl:loop_user|Efl.Loop_User]] //(class)//
    * [[:develop:api:efl:object|Efl.Object]] //(class)//


++++
===== Members =====

**[[:develop:api:efl:promise:method:connect|connect]]**\\
> %%Connects a future output to this promise.%%
<code c>
Eina_Bool efl_promise_connect(Eo *obj, Efl_Future *f);
</code>
\\
**[[:develop:api:efl:promise:method:constructor|constructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
> %%Call the object's constructor.%%
<code c>
Efl_Object *efl_constructor(Eo *obj);
</code>
\\
**[[:develop:api:efl:promise:method:destructor|destructor]]**// [Overridden from [[:develop:api:efl:object|Efl.Object]]]//\\
> %%Call the object's destructor.%%
<code c>
void efl_destructor(Eo *obj);
</code>
\\
**[[:develop:api:efl:promise:method:progress_set|progress_set]]**\\
> %%Updates the progress and send it immediately to all connected Efl_Future.%%
<code c>
void efl_promise_progress_set(Eo *obj, const void *p);
</code>
\\
**[[:develop:api:efl:promise:property:failed|failed]]** //**(set)**//\\
> %%Defines the failure state of this promise.%%
<code c>
void efl_promise_failed_set(Eo *obj, Eina_Error err);
</code>
\\
**[[:develop:api:efl:promise:property:future|future]]** //**(get)**//\\
> %%Requests a new future linked to this promise.%%
<code c>
Efl_Future *efl_promise_future_get(const Eo *obj);
</code>
\\
**[[:develop:api:efl:promise:property:value|value]]** //**(set)**//\\
> %%The value expected by all connected future.%%
<code c>
void efl_promise_value_set(Eo *obj, void *v, Eina_Free_Cb free_cb);
</code>
\\

==== Inherited ====

[[:develop:api:efl:loop_user|Efl.Loop_User]]\\
> **[[:develop:api:efl:loop_user:property:loop|loop]]** //**(get)**//, **[[:develop:api:efl:loop_user:property:parent|parent]]** //**(get, set)**//\\
[[:develop:api:efl:object|Efl.Object]]\\
> **[[:develop:api:efl:object:method:children_iterator_new|children_iterator_new]]**, **[[:develop:api:efl:object:method:composite_attach|composite_attach]]**, **[[:develop:api:efl:object:method:composite_detach|composite_detach]]**, **[[:develop:api:efl:object:method:composite_part_is|composite_part_is]]**, **[[:develop:api:efl:object:method:debug_name_override|debug_name_override]]**, **[[:develop:api:efl:object:method:del|del]]**, **[[:develop:api:efl:object:method:event_callback_forwarder_add|event_callback_forwarder_add]]**, **[[:develop:api:efl:object:method:event_callback_forwarder_del|event_callback_forwarder_del]]**, **[[:develop:api:efl:object:method:event_callback_stop|event_callback_stop]]**, **[[:develop:api:efl:object:method:event_freeze|event_freeze]]**, **[[:develop:api:efl:object:method:event_global_freeze|event_global_freeze]]**, **[[:develop:api:efl:object:method:event_global_thaw|event_global_thaw]]**, **[[:develop:api:efl:object:method:event_thaw|event_thaw]]**, **[[:develop:api:efl:object:method:finalize|finalize]]**, **[[:develop:api:efl:object:method:name_find|name_find]]**, **[[:develop:api:efl:object:method:provider_find|provider_find]]**, **[[:develop:api:efl:object:property:allow_parent_unref|allow_parent_unref]]** //**(get, set)**//, **[[:develop:api:efl:object:property:comment|comment]]** //**(get, set)**//, **[[:develop:api:efl:object:property:event_freeze_count|event_freeze_count]]** //**(get)**//, **[[:develop:api:efl:object:property:event_global_freeze_count|event_global_freeze_count]]** //**(get)**//, **[[:develop:api:efl:object:property:finalized|finalized]]** //**(get)**//, **[[:develop:api:efl:object:property:name|name]]** //**(get, set)**//
===== Events =====

**[[:develop:api:efl:promise:event:future_none|future,none]]**\\
> %%This event is triggered whenever there is no more future connected to the promise.%%
<code c>
EFL_PROMISE_EVENT_FUTURE_NONE(void)
</code>
\\ **[[:develop:api:efl:promise:event:future_progress_set|future,progress,set]]**\\
> %%This event is triggered whenever a future has a progress callback registered and the user does not hold any more reference on it.%%
<code c>
EFL_PROMISE_EVENT_FUTURE_PROGRESS_SET(Efl_Future *)
</code>
\\ **[[:develop:api:efl:promise:event:future_set|future,set]]**\\
> %%This event is triggered whenever a future is fully set to receive all events and that the user of it do not hold any more reference on it.%%
<code c>
EFL_PROMISE_EVENT_FUTURE_SET(Efl_Future *)
</code>
\\ ==== Inherited ====

[[:develop:api:efl:object|Efl.Object]]\\
> **[[:develop:api:efl:object:event:callback_add|callback,add]]**, **[[:develop:api:efl:object:event:callback_del|callback,del]]**, **[[:develop:api:efl:object:event:del|del]]**