4 Service org.moblin.connman
5 Interface org.moblin.connman.Service
6 Object path [variable prefix]/{service0,service1,...}
8 Methods dict GetProperties()
10 Returns properties for the service object. See
11 the properties section for available properties.
13 Possible Errors: [service].Error.InvalidArguments
15 void SetProperty(string name, variant value)
17 Changes the value of the specified property. Only
18 properties that are listed as read-write are
19 changeable. On success a PropertyChanged signal
22 Possible Errors: [service].Error.InvalidArguments
23 [service].Error.InvalidProperty
25 void ClearProperty(string name)
27 Clears the value of the specified property.
29 Possible Errors: [service].Error.InvalidArguments
30 [service].Error.InvalidProperty
34 Connect this service. It will attempt to connect
35 WiFi, WiMAX or Bluetooth services.
37 For Ethernet devices this method can only be used
38 if it has previously been disconnected. Otherwise
39 the plugging of a cable will trigger connecting
40 automatically. If no cable is plugged in this method
43 This method call will only return in case of an
44 error or when the service is fully connected. So
45 setting a longer D-Bus timeout might be a really
48 Possible Errors: [service].Error.InvalidArguments
52 Disconnect this service. If the service is not
53 connected an error message will be generated.
55 On Ethernet devices this will disconnect the IP
56 details from the service. It will not magically
57 unplug the cable. When no cable is plugged in this
60 This method can also be used to abort a previous
61 connectiong attempt via the Connect method.
63 Possible Errors: [service].Error.InvalidArguments
67 A successfully connected service with Favorite=true
68 can be removed this way. If it is connected, it will
69 be automatically disconnected first.
71 If the service requires a passphrase it will be
72 cleared and forgotten when removing.
74 This is similar to setting the Favorite property
75 to false, but that is currently not supported.
77 In the case a connection attempt failed and the
78 service is in the State=failure, this method can
79 also be used to reset the service.
81 Calling this method on Ethernet devices will cause
82 an error message. It is not possible to remove these
85 Possible Errors: [service].Error.InvalidArguments
87 void MoveBefore(object service)
89 If a service has been used before, this allows a
90 reorder of the favorite services.
92 The target service object must be part of this
93 profile. Moving between profiles is not supported.
95 Possible Errors: [service].Error.InvalidArguments
97 void MoveAfter(object service)
99 If a service has been used before, this allows a
100 reorder of the favorite services.
102 The target service object must be part of this
103 profile. Moving between profiles is not supported.
105 Possible Errors: [service].Error.InvalidArguments
109 Reset the counter statistics.
111 Possible Errors: None
113 Signals PropertyChanged(string name, variant value)
115 This signal indicates a changed value of the given
118 Properties string State [readonly]
120 The service state information.
122 Valid states are "idle", "failure", "association",
123 "configuration" and "ready".
125 Also "login" and "online" states are used. The
126 state "online" signals that an Internet connection
127 is available and has been verified.
129 string Error [readonly]
131 The service error status details.
133 When error occur during connection or disconnection
134 the detailed information are represented in this
135 property to help the user interface to present the
136 user with alternate options.
138 This property is only valid when the service is in
139 the "failure" state. Otherwise it might be empty or
142 Current defined error code is "dhcp-failed".
144 string Name [readonly]
146 The service name (for example "Wireless" etc.)
148 This name can be used for directly displaying it in
149 the application. It has pure informational purpose.
151 For Ethernet devices and hidden WiFi networks it is
152 not guaranteed that this property is present.
154 string Type [readonly]
156 The service type (for example "ethernet", "wifi" etc.)
158 This information should only be used to determine
159 advanced properties or showing the correct icon
162 string Mode [readonly]
164 If the service type is WiFi or Cellular, then this
165 property is present and contains the mode of the
168 For WiFi services the possible values are "managed"
169 and "adhoc". For Cellular services it describes the
170 network technology. Possible values are "gprs", "edge"
173 This property might be only present for WiFi and
176 string Security [readonly]
178 If the service type is WiFi, then this property is
179 present and contains the security method or key
182 Possible values are "none", "wep", "psk" and
183 also "ieee8021x". Alternate values for "psk"
184 can also be "wpa" and "rsn".
186 This property might be only present for WiFi
189 boolean LoginRequired [readonly]
191 This property indicates that an additional login
192 step is needed before the connection establishment
195 string Passphrase [readwrite]
197 If the service type is WiFi, then this property
198 can be used to store a passphrase.
200 No PropertyChanged signals will be send for this
201 property. The PassphraseRequired property should
202 be monitored instead.
204 This property might also not always be included
205 since it is protected by a different security policy.
207 boolean PassphraseRequired [readonly]
209 If the service type is WiFi, then this property
210 indicates if a passphrase is required.
212 If a passphrase has been set already or if no
213 passphrase is needed, then this property will
216 uint8 Strength [readonly]
218 Indicates the signal strength of the service. This
219 is a normalized value between 0 and 100.
221 This property will not be present for Ethernet
224 boolean Favorite [readonly]
226 Will be true if a cable is plugged in or the user
227 selected and successfully connected to this service.
229 This value is automatically changed and to revert
230 it back to false the Remove() method needs to be
233 boolean Immutable [readonly]
235 This value will be set to true if the service is
236 configured externally via a configuration file.
238 The only valid operation are Connect() and of
239 course Disconnect(). The Remove() method will
242 boolean AutoConnect [readwrite]
244 If set to true, this service will auto-connect
245 when not other connection is available.
247 For favorite services it is possible to change
248 this value to prevent or permit automatic
251 boolean SetupRequired [readonly]
253 If the service is Cellular, then this property
254 indicates that some extra setup steps are required.
256 In most cases it is required to fill in the APN
259 string APN [readwrite]
261 If the service is Cellular, then this property
262 contains the APN details.
264 The APN is network provider specific and even
265 sometimes data plan specific. Possible examples
266 are "isp.cingular" or "internet.t-mobile".
268 string MCC [readonly]
270 If the service is Cellular, then this property
271 contains the Mobile Country Code.
273 string MNC [readonly]
275 If the service is Cellular, then this property
276 contains the Mobile Network Code.
278 boolean Roaming [readonly]
280 This property indicates if this service is roaming.
282 In the case of Cellular services this normally
283 indicates connections to a foreign provider when
286 array{string} Nameservers [readonly]
288 The list of currently active nameservers for this
289 service. If the server is not in READY or ONLINE
290 state than this list will be empty.
292 Global nameservers are automatically added to this
293 list. The array represents a sorted list of the
294 current nameservers. The first one has the highest
295 priority and is used by default.
297 When using DHCP this array represents the nameservers
298 provided by the network. In case of manual settings,
299 the ones from Nameservers.Configuration are used.
301 array{string} Nameservers.Configuration [readwrite]
303 The list of manually configured domain name
304 servers. Some 3G networks don't provide correct
305 name servers and this allows for an override.
307 This array is sorted by priority and the first
308 entry in the list represents the nameserver with
309 the highest priority.
311 When using manual configuration and no global
312 nameservers are configured, then it is useful
313 to configure this setting.
315 Changes to the domain name servers can be done
316 at any time. It will not cause a disconnect of
317 the service. However there might be small window
318 where name resolution might fail.
320 array{string} Domains [readonly]
322 The list of currently used search domains.
324 array{string} Domains.Configuration [readwrite]
326 The list of manually configured search domains.
330 string Method [readonly]
332 Possible values are "dhcp", "manual"
335 The value "fixed" indicates an IP address
336 that can not be modified. For example
337 cellular networks return fixed information.
339 string Address [readonly]
341 The current configured IPv4 address.
343 string Netmask [readonly]
345 The current configured IPv4 netmask.
347 string Gateway [readonly]
349 The current configured IPv4 gateway.
351 dict IPv4.Configuration [readwrite]
353 Same values as IPv4 property. The IPv4 represents
354 the actual system configuration while this allows
357 Changing these settings will cause a state change
358 of the service. The service will become unavailable
359 until the new configuration has been successfully
364 string Method [readonly]
366 Possible values are "dhcp", "manual"
369 The value "fixed" indicates an IP address
370 that can not be modified. For example
371 cellular networks return fixed information.
373 "dhcp" is not supported currently.
375 string Address [readonly]
377 The current configured IPv6 address.
379 uint8 PrefixLength [readonly]
381 The prefix length of the IPv6 address.
383 string Gateway [readonly]
385 The current configured IPv6 gateway.
387 dict IPv6.Configuration [readwrite]
389 Same values as IPv6 property. The IPv6 represents
390 the actual system configuration while this allows
393 Changing these settings will cause a state change
394 of the service. The service will become unavailable
395 until the new configuration has been successfully
398 dict Proxy [readonly]
400 string Method [readonly]
402 Possible values are "direct", "auto" and
405 If the DHCP server, or WPAD protocol, provides
406 an automatic configuration URL, then this value
407 is set to "auto" in case "auto" is configured"
408 referenced by the URL value. If "auto" is
409 configured and DHCP and WPAD auto-discover
410 methods fails then method will be "direct".
412 In case of "auto" method, the URL file has
413 to be provided. In case of "direct" no
414 additional information are provided. For
415 the "manual" method the Servers have to
418 string URL [readonly]
420 Automatic proxy configuration URL. Used by
423 array{string} Servers [readonly]
425 Used when "manual" method is set.
427 List of proxy URIs. The URI without a protocol
428 will be interpreted as the generic proxy URI.
429 All others will target a specific protocol and
432 Example for generic proxy server entry would
433 be like this: "server.example.com:911".
435 array{string} Excludes [readonly]
437 Used when "manual" method is set.
439 List of hosts which can be accessed directly.
441 dict Proxy.Configuration [readwrite]
443 Same values as Proxy property. The Proxy represents
444 the actual system configuration while this allows
447 If "auto" method is set with an empty URL, then
448 WPAD protocol will be ran. Otherwise the specified
451 dict Provider [readonly]
453 string Host [readonly]
457 string Domain [readonly]
461 string Name [readonly]
465 string Type [readonly]
469 dict Ethernet [readonly]
471 string Method [readonly]
473 Possible values are "auto" and "manual".
475 string Interface [readonly]
477 Interface name (for example eth0).
479 string Address [readonly]
481 Ethernet device address (MAC address).
483 uint16 MTU [readonly]
485 The Ethernet MTU (default is 1500).
487 uint16 Speed [readonly]
489 Selected speed of the line.
491 This information might not always be
494 string Duplex [readonly]
496 Selected duplex settings of the line.
498 Possible values are "half" and "full".
500 This information might not always be