doc/service-api.txt

   1 Service hierarchy
   2 =================
   3
   4 Service         org.moblin.connman
   5 Interface       org.moblin.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" and "ready".
 124
 125                         Also "login" and "online" states are used. The
 126                         state "online" signals that an Internet connection
 127                         is available and has been verified.
 128
 129                 string Error [readonly]
 130
 131                         The service error status details.
 132
 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.
 137
 138                         This property is only valid when the service is in
 139                         the "failure" state. Otherwise it might be empty or
 140                         not present at all.
 141
 142                         Current defined error code is "dhcp-failed".
 143
 144                 string Name [readonly]
 145
 146                         The service name (for example "Wireless" etc.)
 147
 148                         This name can be used for directly displaying it in
 149                         the application. It has pure informational purpose.
 150
 151                         For Ethernet devices and hidden WiFi networks it is
 152                         not guaranteed that this property is present.
 153
 154                 string Type [readonly]
 155
 156                         The service type (for example "ethernet", "wifi" etc.)
 157
 158                         This information should only be used to determine
 159                         advanced properties or showing the correct icon
 160                         to the user.
 161
 162                 string Mode [readonly]
 163
 164                         If the service type is WiFi or Cellular, then this
 165                         property is present and contains the mode of the
 166                         network.
 167
 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"
 171                         and "umts".
 172
 173                         This property might be only present for WiFi and
 174                         Cellular services.
 175
 176                 string Security [readonly]
 177
 178                         If the service type is WiFi, then this property is
 179                         present and contains the security method or key
 180                         management setting.
 181
 182                         Possible values are "none", "wep", "psk" and
 183                         also "ieee8021x". Alternate values for "psk"
 184                         can also be "wpa" and "rsn".
 185
 186                         This property might be only present for WiFi
 187                         services.
 188
 189                 string Passphrase [readwrite]
 190
 191                         If the service type is WiFi, then this property
 192                         can be used to store a passphrase.
 193
 194                         No PropertyChanged signals will be send for this
 195                         property. The PassphraseRequired property should
 196                         be monitored instead.
 197
 198                         This property might also not always be included
 199                         since it is protected by a different security policy.
 200
 201                 boolean PassphraseRequired [readonly]
 202
 203                         If the service type is WiFi, then this property
 204                         indicates if a passphrase is required.
 205
 206                         If a passphrase has been set already or if no
 207                         passphrase is needed, then this property will
 208                         be set to false.
 209
 210                 uint8 Strength [readonly]
 211
 212                         Indicates the signal strength of the service. This
 213                         is a normalized value between 0 and 100.
 214
 215                         This property will not be present for Ethernet
 216                         devices.
 217
 218                 boolean Favorite [readonly]
 219
 220                         Will be true if a cable is plugged in or the user
 221                         selected and successfully connected to this service.
 222
 223                         This value is automatically changed and to revert
 224                         it back to false the Remove() method needs to be
 225                         used.
 226
 227                 boolean Immutable [readonly]
 228
 229                         This value will be set to true if the service is
 230                         configured externally via a configuration file.
 231
 232                         The only valid operation are Connect() and of
 233                         course Disconnect(). The Remove() method will
 234                         result in an error.
 235
 236                 boolean AutoConnect [readwrite]
 237
 238                         If set to true, this service will auto-connect
 239                         when not other connection is available.
 240
 241                         For favorite services it is possible to change
 242                         this value to prevent or permit automatic
 243                         connection attempts.
 244
 245                 boolean SetupRequired [readonly]
 246
 247                         If the service is Cellular, then this property
 248                         indicates that some extra setup steps are required.
 249
 250                         In most cases it is required to fill in the APN
 251                         details.
 252
 253                 string APN [readwrite]
 254
 255                         If the service is Cellular, then this property
 256                         contains the APN details.
 257
 258                         The APN is network provider specific and even
 259                         sometimes data plan specific. Possible examples
 260                         are "isp.cingular" or "internet.t-mobile".
 261
 262                 string MCC [readonly]
 263
 264                         If the service is Cellular, then this property
 265                         contains the Mobile Country Code.
 266
 267                 string MNC [readonly]
 268
 269                         If the service is Cellular, then this property
 270                         contains the Mobile Network Code.
 271
 272                 boolean Roaming [readonly]
 273
 274                         This property indicates if this service is roaming.
 275
 276                         In the case of Cellular services this normally
 277                         indicates connections to a foreign provider when
 278                         traveling abroad.
 279
 280                 array{string} Nameservers [readonly]
 281
 282                         The list of currently active nameservers for this
 283                         service. If the server is not in READY, LOGIN or
 284                         ONLINE state than this list will be empty.
 285
 286                         Global nameservers are automatically added to this
 287                         list. The array represents a sorted list of the
 288                         current nameservers. The first one has the highest
 289                         priority and is used by default.
 290
 291                         When using DHCP this array represents the nameservers
 292                         provided by the network. In case of manual settings,
 293                         the ones from Nameservers.Configuration are used.
 294
 295                 array{string} Nameservers.Configuration [readwrite]
 296
 297                         The list of manually configured domain name
 298                         servers. Some 3G networks don't provide correct
 299                         name servers and this allows for an override.
 300
 301                         This array is sorted by priority and the first
 302                         entry in the list represents the nameserver with
 303                         the highest priority.
 304
 305                         When using manual configuration and no global
 306                         nameservers are configured, then it is useful
 307                         to configure this setting.
 308
 309                         Changes to the domain name servers can be done
 310                         at any time. It will not cause a disconnect of
 311                         the service. However there might be small window
 312                         where name resolution might fail.
 313
 314                 array{string} Domains [readonly]
 315
 316                         The list of currently used search domains.
 317
 318                 array{string} Domains.Configuration [readwrite]
 319
 320                         The list of manually configured search domains.
 321
 322                 dict IPv4 [readonly]
 323
 324                         string Method [readonly]
 325
 326                                 Possible values are "dhcp", "manual"
 327                                 and "off".
 328
 329                                 The value "fixed" indicates an IP address
 330                                 that can not be modified. For example
 331                                 cellular networks return fixed information.
 332
 333                         string Address [readonly]
 334
 335                                 The current configured IPv4 address.
 336
 337                         string Netmask [readonly]
 338
 339                                 The current configured IPv4 netmask.
 340
 341                         string Gateway [readonly]
 342
 343                                 The current configured IPv4 gateway.
 344
 345                 dict IPv4.Configuration [readwrite]
 346
 347                         Same values as IPv4 property. The IPv4 represents
 348                         the actual system configuration while this allows
 349                         user configuration.
 350
 351                         Changing these settings will cause a state change
 352                         of the service. The service will become unavailable
 353                         until the new configuration has been successfully
 354                         installed.
 355
 356                 dict Proxy [readonly]
 357
 358                         string Method [readonly]
 359
 360                                 Possible values are "direct", "auto",
 361                                 "manual" and "auto-config".
 362
 363                                 If the DHCP server provides an automatic
 364                                 configuration URL, then this value is set
 365                                 to "auto-config". The PAC file will be
 366                                 referenced by the URL value.
 367
 368                                 If no automatic configuration is available,
 369                                 then "direct" is set.
 370
 371                                 The values "auto" and "manual" are not yet
 372                                 supported.
 373
 374                         string URL [readonly]
 375
 376                                 Automatic proxy configuration URL.
 377
 378                 dict Ethernet [readonly]
 379
 380                         string Method [readonly]
 381
 382                                 Possible values are "auto" and "manual".
 383
 384                         string Interface [readonly]
 385
 386                                 Interface name (for example eth0).
 387
 388                         string Address [readonly]
 389
 390                                 Ethernet device address (MAC address).
 391
 392                         uint16 MTU [readonly]
 393
 394                                 The Ethernet MTU (default is 1500).
 395
 396                         uint16 Speed [readonly]
 397
 398                                 Selected speed of the line.
 399
 400                                 This information might not always be
 401                                 available.
 402
 403                         string Duplex [readonly]
 404
 405                                 Selected duplex settings of the line.
 406
 407                                 Possible values are "half" and "full".
 408
 409                                 This information might not always be
 410                                 available.