doc/service-api.txt

   1 Service hierarchy
   2 =================
   3
   4 Service         net.connman
   5 Interface       net.connman.Service
   6 Object path     [variable prefix]/{service0,service1,...}
   7
   8 Methods         dict GetProperties()  [deprecated]
   9
  10                         Returns properties for the service object. See
  11                         the properties section for available properties.
  12
  13                         Usage of this method is highly discouraged. Use
  14                         the Manager.GetServices() method instead.
  15
  16                         Possible Errors: [service].Error.InvalidArguments
  17
  18                 void SetProperty(string name, variant value)
  19
  20                         Changes the value of the specified property. Only
  21                         properties that are listed as read-write are
  22                         changeable. On success a PropertyChanged signal
  23                         will be emitted.
  24
  25                         Properties cannot be set for hidden WiFi service
  26                         entries or provisioned services.
  27
  28                         Possible Errors: [service].Error.InvalidArguments
  29                                          [service].Error.InvalidProperty
  30
  31                 void ClearProperty(string name)
  32
  33                         Clears the value of the specified property. Only
  34                         the readonly Error property can be cleared using
  35                         this method call. When cleared the service is reset
  36                         to the idle state.
  37
  38                         Possible Errors: [service].Error.InvalidProperty
  39
  40                 void Connect()
  41
  42                         Connect this service. It will attempt to connect
  43                         WiFi or Bluetooth services.
  44
  45                         For Ethernet devices this method can only be used
  46                         if it has previously been disconnected. Otherwise
  47                         the plugging of a cable will trigger connecting
  48                         automatically. If no cable is plugged in this method
  49                         will fail.
  50
  51                         This method call will only return in case of an
  52                         error or when the service is fully connected. So
  53                         setting a longer D-Bus timeout might be a really
  54                         good idea.
  55
  56                         Calling Connect() on a hidden WiFi service entry will
  57                         query the missing SSID via the Agent API causing a
  58                         WiFi service with the given SSID to be scanned,
  59                         created and connected.
  60
  61                         Possible Errors: [service].Error.InvalidArguments
  62
  63                 void Disconnect()
  64
  65                         Disconnect this service. If the service is not
  66                         connected an error message will be generated.
  67
  68                         On Ethernet devices this will disconnect the IP
  69                         details from the service. It will not magically
  70                         unplug the cable. When no cable is plugged in this
  71                         method will fail.
  72
  73                         This method can also be used to abort a previous
  74                         connection attempt via the Connect method.
  75
  76                         Hidden WiFi service entries cannot be disconnected
  77                         as they always stay in idle state.
  78
  79                         Possible Errors: [service].Error.InvalidArguments
  80
  81                 void Remove()
  82
  83                         A successfully connected service with Favorite=true
  84                         can be removed this way. If it is connected, it will
  85                         be automatically disconnected first.
  86
  87                         If the service requires a passphrase it will be
  88                         cleared and forgotten when removing.
  89
  90                         This is similar to setting the Favorite property
  91                         to false, but that is currently not supported.
  92
  93                         In the case a connection attempt failed and the
  94                         service is in the state "failure", "idle" or
  95                         "disconnect", this method can also be used
  96                         to reset the service.
  97
  98                         Calling this method on Ethernet devices, hidden WiFi
  99                         services or provisioned services will cause an error
 100                         message. It is not possible to remove these kind of
 101                         services.
 102
 103                         Possible Errors: [service].Error.InvalidArguments
 104
 105                 void MoveBefore(object service)
 106
 107                         If a service has been used before, this allows a
 108                         reorder of the favorite services.
 109
 110                         Possible Errors: [service].Error.InvalidArguments
 111
 112                 void MoveAfter(object service)
 113
 114                         If a service has been used before, this allows a
 115                         reorder of the favorite services.
 116
 117                         Possible Errors: [service].Error.InvalidArguments
 118
 119                 void ResetCounters()  [experimental]
 120
 121                         Reset the counter statistics.
 122
 123                         Possible Errors: None
 124
 125 Signals         PropertyChanged(string name, variant value)
 126
 127                         This signal indicates a changed value of the given
 128                         property.
 129
 130 Properties      string State [readonly]
 131
 132                         The service state information.
 133
 134                         Valid states are "idle", "failure", "association",
 135                         "configuration", "ready", "disconnect" and "online".
 136
 137                         The "ready" state signals a successfully
 138                         connected device. "online" signals that an
 139                         Internet connection is available and has been
 140                         verified.
 141
 142                         See doc/overview-api.txt for more information about
 143                         state transitions.
 144
 145                 string Error [readonly]
 146
 147                         The service error status details.
 148
 149                         When error occur during connection or disconnection
 150                         the detailed information is represented in this
 151                         property to help the user interface to present the
 152                         user with alternate options.
 153
 154                         This property is only valid when the service is in
 155                         the "failure" state. Otherwise it might be empty or
 156                         not present at all.
 157
 158                         Currently defined error codes are: "out-of-range",
 159                         "pin-missing", "dhcp-failed", "connect-failed",
 160                         "login-failed", "auth-failed" and "invalid-key".
 161
 162                 string Name [readonly]
 163
 164                         The service name (for example "Wireless" etc.)
 165
 166                         This name can be used for directly displaying it in
 167                         the application. It has pure informational purpose
 168                         and no attempt should be made to translate it.
 169
 170                         For Ethernet devices and hidden WiFi networks this
 171                         property is not present.
 172
 173                 string Type [readonly]
 174
 175                         The service type (for example "ethernet", "wifi" etc.)
 176
 177                         This information should only be used to determine
 178                         advanced properties or showing the correct icon
 179                         to the user.
 180
 181                         Together with a missing Name property, this can
 182                         be used to identify hidden WiFi networks.
 183
 184                 array{string} Security [readonly]
 185
 186                         If the service type is WiFi, then this property is
 187                         present and contains the list of security methods
 188                         or key management settings.
 189
 190                         Possible values are "none", "wep", "psk", "ieee8021x"
 191                         and also "wps".
 192
 193                         This property might be only present for WiFi
 194                         services.
 195
 196                 uint8 Strength [readonly]
 197
 198                         Indicates the signal strength of the service. This
 199                         is a normalized value between 0 and 100.
 200
 201                         This property will not be present for Ethernet
 202                         devices.
 203
 204                 boolean Favorite [readonly]
 205
 206                         Will be true if a cable is plugged in or the user
 207                         selected and successfully connected to this service.
 208
 209                         This value is automatically changed and to revert
 210                         it back to false the Remove() method needs to be
 211                         used.
 212
 213                 boolean Immutable [readonly]
 214
 215                         This value will be set to true if the service is
 216                         configured externally via a configuration file.
 217
 218                         The only valid operations are Connect(), Disconnect()
 219                         and changing the AutoConnect property. The Remove()
 220                         method will result in an error.
 221
 222                 boolean AutoConnect [readwrite]
 223
 224                         If set to true, this service will auto-connect
 225                         when no other connection is available.
 226
 227                         The service won't auto-connect while roaming.
 228
 229                         For favorite services it is possible to change
 230                         this value to prevent or permit automatic
 231                         connection attempts.
 232
 233                 boolean Roaming [readonly]
 234
 235                         This property indicates if this service is roaming.
 236
 237                         In the case of Cellular services this normally
 238                         indicates connections to a foreign provider when
 239                         traveling abroad.
 240
 241                 array{string} Nameservers [readonly]
 242
 243                         The list of currently active nameservers for this
 244                         service. If the server is not in READY or ONLINE
 245                         state than this list will be empty.
 246
 247                         Global nameservers are automatically added to this
 248                         list. The array represents a sorted list of the
 249                         current nameservers. The first one has the highest
 250                         priority and is used by default.
 251
 252                         When using DHCP this array represents the nameservers
 253                         provided by the network. In case of manual settings,
 254                         the ones from Nameservers.Configuration are used.
 255
 256                 array{string} Nameservers.Configuration [readwrite]
 257
 258                         The list of manually configured domain name
 259                         servers. Some cellular networks don't provide
 260                         correct name servers and this allows for an
 261                         override.
 262
 263                         This array is sorted by priority and the first
 264                         entry in the list represents the nameserver with
 265                         the highest priority.
 266
 267                         When using manual configuration and no global
 268                         nameservers are configured, then it is useful
 269                         to configure this setting.
 270
 271                         Changes to the domain name servers can be done
 272                         at any time. It will not cause a disconnect of
 273                         the service. However there might be small window
 274                         where name resolution might fail.
 275
 276                 array{string} Timeservers [readonly]
 277
 278                         The list of currently active timeservers for this
 279                         service. If the server is not in READY or ONLINE
 280                         state than this list will be empty.
 281
 282                 array{string} Timeservers.Configuration [readwrite]
 283
 284                         The list of manually configured time servers.
 285
 286                         The first entry in the list represents the
 287                         timeserver with the highest priority.
 288
 289                         When using manual configuration this setting
 290                         is useful to override all the other timeserver
 291                         settings. This is service specific, hence only
 292                         the values for the default service are used.
 293
 294                         Changes to this property will result in restart
 295                         of NTP query.
 296
 297                 array{string} Domains [readonly]
 298
 299                         The list of currently used search domains taken
 300                         from Domains.Configurations if set, otherwise a
 301                         domain name if provided by DHCP or VPNs.
 302
 303                 array{string} Domains.Configuration [readwrite]
 304
 305                         The list of manually configured search domains.
 306
 307                 dict IPv4 [readonly]
 308
 309                         string Method [readonly]
 310
 311                                 Possible values are "dhcp", "manual", "auto"
 312                                 and "off".
 313
 314                                 It could be "auto" in case address was got
 315                                 through IPv4LL after DHCP failed. In this
 316                                 case also IPv4.Configuration will become
 317                                 "auto" to allow user to ask for a DHCP
 318                                 address at any time.
 319
 320                                 The value "fixed" indicates an IP address
 321                                 that can not be modified. For example
 322                                 cellular networks return fixed information.
 323
 324                         string Address [readonly]
 325
 326                                 The current configured IPv4 address.
 327
 328                         string Netmask [readonly]
 329
 330                                 The current configured IPv4 netmask.
 331
 332                         string Gateway [readonly]
 333
 334                                 The current configured IPv4 gateway.
 335
 336                 dict IPv4.Configuration [readwrite]
 337
 338                         Same values as IPv4 property. The IPv4 represents
 339                         the actual system configuration while this allows
 340                         user configuration.
 341
 342                         Changing these settings will cause a state change
 343                         of the service. The service will become unavailable
 344                         until the new configuration has been successfully
 345                         installed.
 346
 347                 dict IPv6 [readonly]
 348
 349                         string Method [readonly]
 350
 351                                 Possible values are "auto", "manual", "6to4"
 352                                 and "off".
 353
 354                                 The value "fixed" indicates an IP address
 355                                 that can not be modified. For example
 356                                 cellular networks return fixed information.
 357                                 The value "6to4" is returned if 6to4 tunnel
 358                                 is created by connman. The tunnel can only be
 359                                 created if method was set to "auto" by the
 360                                 user. User cannot set the method to "6to4".
 361
 362                         string Address [readonly]
 363
 364                                 The current configured IPv6 address.
 365
 366                         uint8 PrefixLength [readonly]
 367
 368                                 The prefix length of the IPv6 address.
 369
 370                         string Gateway [readonly]
 371
 372                                 The current configured IPv6 gateway.
 373
 374                         string Privacy [readonly]
 375
 376                                 Enable or disable IPv6 privacy extension
 377                                 that is described in RFC 4941. The value
 378                                 has only meaning if Method is set to "auto".
 379
 380                                 Value "disabled" means that privacy extension
 381                                 is disabled and normal autoconf addresses are
 382                                 used.
 383
 384                                 Value "enabled" means that privacy extension is
 385                                 enabled and system prefers to use public
 386                                 addresses over temporary addresses.
 387
 388                                 Value "prefered" means that privacy extension is
 389                                 enabled and system prefers temporary addresses
 390                                 over public addresses.
 391
 392                                 Default value is "disabled".
 393
 394                 dict IPv6.Configuration [readwrite]
 395
 396                         Same values as IPv6 property. The IPv6 represents
 397                         the actual system configuration while this allows
 398                         user configuration.
 399
 400                         Changing these settings will cause a state change
 401                         of the service. The service will become unavailable
 402                         until the new configuration has been successfully
 403                         installed.
 404
 405                 dict Proxy [readonly]
 406
 407                         string Method [readonly]
 408
 409                                 Possible values are "direct", "auto" and
 410                                 "manual".
 411
 412                                 In case of "auto" method, the URL file can be
 413                                 provided unless you want to let DHCP/WPAD
 414                                 auto-discover to be tried. In such case if DHCP
 415                                 and WPAD auto-discover methods fails then
 416                                 method will be "direct".
 417
 418                                 In case of "direct" no additional information
 419                                 are provided. For the "manual" method the
 420                                 Servers have to be set, Excludes is optional.
 421
 422                         string URL [readonly]
 423
 424                                 Automatic proxy configuration URL. Used by
 425                                 "auto" method.
 426
 427                         array{string} Servers [readonly]
 428
 429                                 Used when "manual" method is set.
 430
 431                                 List of proxy URIs. The URI without a protocol
 432                                 will be interpreted as the generic proxy URI.
 433                                 All others will target a specific protocol and
 434                                 only once.
 435
 436                                 Example for generic proxy server entry would
 437                                 be like this: "server.example.com:911".
 438
 439                         array{string} Excludes [readonly]
 440
 441                                 Used when "manual" method is set.
 442
 443                                 List of hosts which can be accessed directly.
 444
 445                 dict Proxy.Configuration [readwrite]
 446
 447                         Same values as Proxy property. The Proxy represents
 448                         the actual system configuration while this allows
 449                         user configuration.
 450
 451                         If "auto" method is set with an empty URL, then
 452                         DHCP/WPAD auto-discover will be tried. Otherwise the
 453                         specified URL will be used.
 454
 455                 dict Provider [readonly]
 456
 457                         string Host [readonly]
 458
 459                                 VPN host IP.
 460
 461                         string Domain [readonly]
 462
 463                                 VPN Domain.
 464
 465                         string Name [readonly]
 466
 467                                 VPN provider Name.
 468
 469                         string Type [readonly]
 470
 471                                 VPN provider type.
 472
 473                 dict Ethernet [readonly]
 474
 475                         string Method [readonly]
 476
 477                                 Possible values are "auto" and "manual".
 478
 479                         string Interface [readonly]
 480
 481                                 Interface name (for example eth0).
 482
 483                         string Address [readonly]
 484
 485                                 Ethernet device address (MAC address).
 486
 487                         uint16 MTU [readonly]
 488
 489                                 The Ethernet MTU (default is 1500).
 490
 491                         uint16 Speed [readonly] [deprecated]
 492
 493                                 Selected speed of the line.
 494
 495                                 This information is not available.
 496
 497                         string Duplex [readonly] [deprecated]
 498
 499                                 Selected duplex settings of the line.
 500                                 Possible values are "half" and "full".
 501
 502                                 This information is not available.