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()  [experimental]
 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".
 171
 172                         This property might be only present for WiFi
 173                         services.
 174
 175                 uint8 Strength [readonly]
 176
 177                         Indicates the signal strength of the service. This
 178                         is a normalized value between 0 and 100.
 179
 180                         This property will not be present for Ethernet
 181                         devices.
 182
 183                 boolean Favorite [readonly]
 184
 185                         Will be true if a cable is plugged in or the user
 186                         selected and successfully connected to this service.
 187
 188                         This value is automatically changed and to revert
 189                         it back to false the Remove() method needs to be
 190                         used.
 191
 192                 boolean Immutable [readonly]
 193
 194                         This value will be set to true if the service is
 195                         configured externally via a configuration file.
 196
 197                         The only valid operation are Connect() and of
 198                         course Disconnect(). The Remove() method will
 199                         result in an error.
 200
 201                 boolean AutoConnect [readwrite]
 202
 203                         If set to true, this service will auto-connect
 204                         when no other connection is available.
 205
 206                         The service won't auto-connect while roaming.
 207
 208                         For favorite services it is possible to change
 209                         this value to prevent or permit automatic
 210                         connection attempts.
 211
 212                 boolean Roaming [readonly]
 213
 214                         This property indicates if this service is roaming.
 215
 216                         In the case of Cellular services this normally
 217                         indicates connections to a foreign provider when
 218                         traveling abroad.
 219
 220                 array{string} Nameservers [readonly]
 221
 222                         The list of currently active nameservers for this
 223                         service. If the server is not in READY or ONLINE
 224                         state than this list will be empty.
 225
 226                         Global nameservers are automatically added to this
 227                         list. The array represents a sorted list of the
 228                         current nameservers. The first one has the highest
 229                         priority and is used by default.
 230
 231                         When using DHCP this array represents the nameservers
 232                         provided by the network. In case of manual settings,
 233                         the ones from Nameservers.Configuration are used.
 234
 235                 array{string} Nameservers.Configuration [readwrite]
 236
 237                         The list of manually configured domain name
 238                         servers. Some cellular networks don't provide
 239                         correct name servers and this allows for an
 240                         override.
 241
 242                         This array is sorted by priority and the first
 243                         entry in the list represents the nameserver with
 244                         the highest priority.
 245
 246                         When using manual configuration and no global
 247                         nameservers are configured, then it is useful
 248                         to configure this setting.
 249
 250                         Changes to the domain name servers can be done
 251                         at any time. It will not cause a disconnect of
 252                         the service. However there might be small window
 253                         where name resolution might fail.
 254
 255                 array{string} Timeservers.Configuration [readwrite]
 256
 257                         The list of manually configured time servers.
 258
 259                         The first entry in the list represents the
 260                         timeserver with the highest priority.
 261
 262                         When using manual configuration this setting
 263                         is useful to override all the other timeserver
 264                         settings. This is service specific, hence only
 265                         the values for the default service are used.
 266
 267                         Changes to this property will result in restart
 268                         of NTP query.
 269
 270                 array{string} Domains [readonly]
 271
 272                         The list of currently used search domains.
 273
 274                 array{string} Domains.Configuration [readwrite]
 275
 276                         The list of manually configured search domains.
 277
 278                 dict IPv4 [readonly]
 279
 280                         string Method [readonly]
 281
 282                                 Possible values are "dhcp", "manual"
 283                                 and "off".
 284
 285                                 The value "fixed" indicates an IP address
 286                                 that can not be modified. For example
 287                                 cellular networks return fixed information.
 288
 289                         string Address [readonly]
 290
 291                                 The current configured IPv4 address.
 292
 293                         string Netmask [readonly]
 294
 295                                 The current configured IPv4 netmask.
 296
 297                         string Gateway [readonly]
 298
 299                                 The current configured IPv4 gateway.
 300
 301                 dict IPv4.Configuration [readwrite]
 302
 303                         Same values as IPv4 property. The IPv4 represents
 304                         the actual system configuration while this allows
 305                         user configuration.
 306
 307                         Changing these settings will cause a state change
 308                         of the service. The service will become unavailable
 309                         until the new configuration has been successfully
 310                         installed.
 311
 312                 dict IPv6 [readonly]
 313
 314                         string Method [readonly]
 315
 316                                 Possible values are "auto", "manual", "6to4"
 317                                 and "off".
 318
 319                                 The value "fixed" indicates an IP address
 320                                 that can not be modified. For example
 321                                 cellular networks return fixed information.
 322                                 The value "6to4" is returned if 6to4 tunnel
 323                                 is created by connman. The tunnel can only be
 324                                 created if method was set to "auto" by the
 325                                 user. User cannot set the method to "6to4".
 326
 327                         string Address [readonly]
 328
 329                                 The current configured IPv6 address.
 330
 331                         uint8 PrefixLength [readonly]
 332
 333                                 The prefix length of the IPv6 address.
 334
 335                         string Gateway [readonly]
 336
 337                                 The current configured IPv6 gateway.
 338
 339                         string Privacy [readonly]
 340
 341                                 Enable or disable IPv6 privacy extension
 342                                 that is described in RFC 4941. The value
 343                                 has only meaning if Method is set to "auto".
 344
 345                                 Value "disabled" means that privacy extension
 346                                 is disabled and normal autoconf addresses are
 347                                 used.
 348
 349                                 Value "enabled" means that privacy extension is
 350                                 enabled and system prefers to use public
 351                                 addresses over temporary addresses.
 352
 353                                 Value "prefered" means that privacy extension is
 354                                 enabled and system prefers temporary addresses
 355                                 over public addresses.
 356
 357                                 Default value is "disabled".
 358
 359                 dict IPv6.Configuration [readwrite]
 360
 361                         Same values as IPv6 property. The IPv6 represents
 362                         the actual system configuration while this allows
 363                         user configuration.
 364
 365                         Changing these settings will cause a state change
 366                         of the service. The service will become unavailable
 367                         until the new configuration has been successfully
 368                         installed.
 369
 370                 dict Proxy [readonly]
 371
 372                         string Method [readonly]
 373
 374                                 Possible values are "direct", "auto" and
 375                                 "manual".
 376
 377                                 In case of "auto" method, the URL file can be
 378                                 provided unless you want to let DHCP/WPAD
 379                                 auto-discover to be tried. In such case if DHCP
 380                                 and WPAD auto-discover methods fails then
 381                                 method will be "direct".
 382
 383                                 In case of "direct" no additional information
 384                                 are provided. For the "manual" method the
 385                                 Servers have to be set, Excludes is optional.
 386
 387                         string URL [readonly]
 388
 389                                 Automatic proxy configuration URL. Used by
 390                                 "auto" method.
 391
 392                         array{string} Servers [readonly]
 393
 394                                 Used when "manual" method is set.
 395
 396                                 List of proxy URIs. The URI without a protocol
 397                                 will be interpreted as the generic proxy URI.
 398                                 All others will target a specific protocol and
 399                                 only once.
 400
 401                                 Example for generic proxy server entry would
 402                                 be like this: "server.example.com:911".
 403
 404                         array{string} Excludes [readonly]
 405
 406                                 Used when "manual" method is set.
 407
 408                                 List of hosts which can be accessed directly.
 409
 410                 dict Proxy.Configuration [readwrite]
 411
 412                         Same values as Proxy property. The Proxy represents
 413                         the actual system configuration while this allows
 414                         user configuration.
 415
 416                         If "auto" method is set with an empty URL, then
 417                         DHCP/WPAD auto-discover will be tried. Otherwise the
 418                         specified URL will be used.
 419
 420                 dict Provider [readonly]
 421
 422                         string Host [readonly]
 423
 424                                VPN host IP.
 425
 426                         string Domain [readonly]
 427
 428                                VPN Domain.
 429
 430                         string Name [readonly]
 431
 432                                VPN provider Name.
 433
 434                         string Type [readonly]
 435
 436                                VPN provider type.
 437
 438                 dict Ethernet [readonly]
 439
 440                         string Method [readonly]
 441
 442                                 Possible values are "auto" and "manual".
 443
 444                         string Interface [readonly]
 445
 446                                 Interface name (for example eth0).
 447
 448                         string Address [readonly]
 449
 450                                 Ethernet device address (MAC address).
 451
 452                         uint16 MTU [readonly]
 453
 454                                 The Ethernet MTU (default is 1500).
 455
 456                         uint16 Speed [readonly]
 457
 458                                 Selected speed of the line.
 459
 460                                 This information might not always be
 461                                 available.
 462
 463                         string Duplex [readonly]
 464
 465                                 Selected duplex settings of the line.
 466
 467                                 Possible values are "half" and "full".
 468
 469                                 This information might not always be
 470                                 available.