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