aboutsummaryrefslogtreecommitdiffstats
path: root/pages/develop/api/efl/net/control/access_point.txt
blob: ead4af9d18ff3fe5bba998536b6c83f1097efa63 (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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
~~Title: Efl.Net.Control.Access_Point~~
====== Efl.Net.Control.Access_Point (class) ======

===== Description =====

%%An access point for network connectivity.%%

%%The %%[[:develop:api:efl:net:control|Efl.Net.Control]]%% is composed of multiple technologies, each create access points to allow configuration and connection.%%

%%An application willing to just get a network connection should prefer to use the @Efl.Net.Session instead.%%

//Since 1.19//

{{page>:develop:api-include:efl:net:control:access_point: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_net_control_access_point [fillcolor = "black", label = "Efl.Net.Control.Access_Point", 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_net_control_access_point -> 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:net:control:access_point:method:connect|connect]]**
<code c>
Efl_Future *efl_net_control_access_point_connect(Eo *obj);
</code>

%%Connects to this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:method:disconnect|disconnect]]**
<code c>
void efl_net_control_access_point_disconnect(Eo *obj);
</code>

%%Disconnects from this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:method:forget|forget]]**
<code c>
void efl_net_control_access_point_forget(Eo *obj);
</code>

%%Disconnects and forgets about this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:auto_connect|auto_connect]]** //**(get, set)**//
<code c>
Eina_Bool efl_net_control_access_point_auto_connect_get(const Eo *obj);
void efl_net_control_access_point_auto_connect_set(Eo *obj, Eina_Bool auto_connect);
</code>

%%Whenever to auto-connect to this access point if no other is connected.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:configuration_domains|configuration_domains]]** //**(get, set)**//
<code c>
Eina_Iterator *efl_net_control_access_point_configuration_domains_get(const Eo *obj);
void efl_net_control_access_point_configuration_domains_set(Eo *obj, Eina_Iterator *domains);
</code>

%%Searches domains configured by user for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:configuration_ipv4|configuration_ipv4]]** //**(get, set)**//
<code c>
void efl_net_control_access_point_configuration_ipv4_get(const Eo *obj, Efl_Net_Control_Access_Point_Ipv4_Method *method, const char **address, const char **netmask, const char **gateway);
void efl_net_control_access_point_configuration_ipv4_set(Eo *obj, Efl_Net_Control_Access_Point_Ipv4_Method method, const char *address, const char *netmask, const char *gateway);
</code>

%%IPv4 configured by user for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:configuration_ipv6|configuration_ipv6]]** //**(get, set)**//
<code c>
void efl_net_control_access_point_configuration_ipv6_get(const Eo *obj, Efl_Net_Control_Access_Point_Ipv6_Method *method, const char **address, uint8_t *prefix_length, const char **netmask, const char **gateway);
void efl_net_control_access_point_configuration_ipv6_set(Eo *obj, Efl_Net_Control_Access_Point_Ipv6_Method method, const char *address, uint8_t prefix_length, const char *netmask, const char *gateway);
</code>

%%IPv6 configured by user for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:configuration_name_servers|configuration_name_servers]]** //**(get, set)**//
<code c>
Eina_Iterator *efl_net_control_access_point_configuration_name_servers_get(const Eo *obj);
void efl_net_control_access_point_configuration_name_servers_set(Eo *obj, Eina_Iterator *name_servers);
</code>

%%DNS (Domain Name Servers) configured by user for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:configuration_proxy|configuration_proxy]]** //**(get, set)**//
<code c>
void efl_net_control_access_point_configuration_proxy_get(const Eo *obj, Efl_Net_Control_Access_Point_Proxy_Method *method, const char **url, Eina_Iterator **servers, Eina_Iterator **excludes);
void efl_net_control_access_point_configuration_proxy_set(Eo *obj, Efl_Net_Control_Access_Point_Proxy_Method method, const char *url, Eina_Iterator *servers, Eina_Iterator *excludes);
</code>

%%Proxy configured by user for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:configuration_time_servers|configuration_time_servers]]** //**(get, set)**//
<code c>
Eina_Iterator *efl_net_control_access_point_configuration_time_servers_get(const Eo *obj);
void efl_net_control_access_point_configuration_time_servers_set(Eo *obj, Eina_Iterator *time_servers);
</code>

%%NTP (Time Server) configured by user for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:domains|domains]]** //**(get)**//
<code c>
Eina_Iterator *efl_net_control_access_point_domains_get(const Eo *obj);
</code>

%%Searches domains in use for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:error|error]]** //**(get)**//
<code c>
Efl_Net_Control_Access_Point_Error efl_net_control_access_point_error_get(const Eo *obj);
</code>

%%If the access point is in error state, this states the error.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:immutable|immutable]]** //**(get)**//
<code c>
Eina_Bool efl_net_control_access_point_immutable_get(const Eo *obj);
</code>

%%Immutable access points are those defined in configuration files and its properties can't be changed using API.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:ipv4|ipv4]]** //**(get)**//
<code c>
void efl_net_control_access_point_ipv4_get(const Eo *obj, Efl_Net_Control_Access_Point_Ipv4_Method *method, const char **address, const char **netmask, const char **gateway);
</code>

%%IPv4 in use for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:ipv6|ipv6]]** //**(get)**//
<code c>
void efl_net_control_access_point_ipv6_get(const Eo *obj, Efl_Net_Control_Access_Point_Ipv6_Method *method, const char **address, uint8_t *prefix_length, const char **netmask, const char **gateway);
</code>

%%IPv6 in use for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:name_servers|name_servers]]** //**(get)**//
<code c>
Eina_Iterator *efl_net_control_access_point_name_servers_get(const Eo *obj);
</code>

%%DNS (Domain Name Servers) in use for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:name|name]]** //**(get)**//
<code c>
const char *efl_net_control_access_point_name_get(const Eo *obj);
</code>

%%The user-friendly access point name.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:priority|priority]]** //**(get, set)**//
<code c>
unsigned int efl_net_control_access_point_priority_get(const Eo *obj);
void efl_net_control_access_point_priority_set(Eo *obj, unsigned int priority);
</code>

%%The access point priority in the current access point listing.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:proxy|proxy]]** //**(get)**//
<code c>
void efl_net_control_access_point_proxy_get(const Eo *obj, Efl_Net_Control_Access_Point_Proxy_Method *method, const char **url, Eina_Iterator **servers, Eina_Iterator **excludes);
</code>

%%Proxy in use for this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:remembered|remembered]]** //**(get)**//
<code c>
Eina_Bool efl_net_control_access_point_remembered_get(const Eo *obj);
</code>

%%Successfully connected access points are remembered.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:roaming|roaming]]** //**(get)**//
<code c>
Eina_Bool efl_net_control_access_point_roaming_get(const Eo *obj);
</code>

%%If it's a cellular access point and it's on roaming.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:security|security]]** //**(get)**//
<code c>
Efl_Net_Control_Access_Point_Security efl_net_control_access_point_security_get(const Eo *obj);
</code>

%%Security options such as WEP, WPS, PSK or none (open).%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:state|state]]** //**(get)**//
<code c>
Efl_Net_Control_Access_Point_State efl_net_control_access_point_state_get(const Eo *obj);
</code>

%%The current state of this access point.%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:strength|strength]]** //**(get)**//
<code c>
uint8_t efl_net_control_access_point_strength_get(const Eo *obj);
</code>

%%Signal strength percentage in 0-100%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:technology|technology]]** //**(get)**//
<code c>
Efl_Net_Control_Technology *efl_net_control_access_point_technology_get(const Eo *obj);
</code>

%%The technology that generated this access point%%\\ 
\\ 
**[[:develop:api:efl:net:control:access_point:property:time_servers|time_servers]]** //**(get)**//
<code c>
Eina_Iterator *efl_net_control_access_point_time_servers_get(const Eo *obj);
</code>

%%NTP (Time Server) in use for this access point.%%\\ 
\\ 

==== Inherited ====

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

===== Events =====

**[[:develop:api:efl:net:control:access_point:event:changed|changed]]**
<code c>
EFL_NET_CONTROL_ACCESS_POINT_EVENT_CHANGED(void)
</code>

%%Called when some properties were changed.%%\\ 
\\ 
==== Inherited ====

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