git.maemo.org Git - connman/blob - doc/network-api.txt

   1 Network hierarchy
   2 =================
   3
   4 Service         org.moblin.connman
   5 Interface       org.moblin.connman.Network
   6 Object path     [variable prefix]/{network0,network1,...}
   7
   8 Methods         dict GetProperties()
   9
  10                         Returns properties for the network 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.DoesNotExist
  24
  25 Signals         PropertyChanged(string name, variant value)
  26
  27                         This signal indicates a changed value of the given
  28                         property.
  29
  30 Properties      string Name [readonly]
  31
  32                         The pretty/long version of the network name. For
  33                         example in case of WiFi this should be the UTF-8
  34                         valid version of the SSID.
  35
  36                 boolean Available [readonly]
  37
  38                         Indicates that this network is in range and
  39                         ready to be used.
  40
  41                         The scanning process can change this property.
  42
  43                 boolean Connected [readonly]
  44
  45                         Indicates that this network is currently connected.
  46
  47                 boolean Remember [readwrite]
  48
  49                         Indicates that this network will be remembered.
  50
  51                         For manually created networks this is set by
  52                         default.
  53
  54                 uint8 Strength [readonly]
  55
  56                         Indicates the signal strength of the network. This
  57                         is a normalized value between 0 and 100.
  58
  59                 object Device [readonly]
  60
  61                         The object path of the device this networks
  62                         belongs to.
  63
  64                 array{byte} WiFi.SSID [readonly]
  65
  66                         If the network type is WiFi, then this property is
  67                         present and contains the binary SSID value.
  68
  69                 string WiFi.Mode [readonly, readwrite]
  70
  71                         If the network type is WiFi, then this property is
  72                         present and contains the mode of the network. The
  73                         possible values are "managed" or "adhoc".
  74
  75                         For scanned networks this value is read only, but in
  76                         case the network was manually created it is also
  77                         changeable.
  78
  79                 string WiFi.Security [readonly, readwrite]
  80
  81                         If the network type is WiFi, then this property is
  82                         present and contains the security method or key
  83                         management setting.
  84
  85                         For scanned networks this value is read only, but in
  86                         case the network was manually created it is also
  87                         changeable.
  88
  89                         Possible values are "none", "wep", "wpa" and "wpa2".
  90
  91                 string WiFi.Passphrase [readwrite]
  92
  93                         If the network type is WiFi and a passhrase is
  94                         requires, then this property is present and contains
  95                         the passphrase in clear text.
  96
  97                         For systems using PolicyKit, the access to this value
  98                         will be protected by the security policy.