Update counter API documentation
[framework/connectivity/connman.git] / doc / service-api.txt
index a1dffa5..a3e3c10 100644 (file)
@@ -74,6 +74,10 @@ Methods              dict GetProperties()
                        This is similar to setting the Favorite property
                        to false, but that is currently not supported.
 
+                       In the case a connection attempt failed and the
+                       service is in the State=failure, this method can
+                       also be used to reset the service.
+
                        Calling this method on Ethernet devices will cause
                        an error message. It is not possible to remove these
                        kind of devices.
@@ -100,6 +104,12 @@ Methods            dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
+               void ResetCounters()
+
+                       Reset the counter statistics.
+
+                       Possible Errors: None
+
 Signals                PropertyChanged(string name, variant value)
 
                        This signal indicates a changed value of the given
@@ -112,6 +122,10 @@ Properties string State [readonly]
                        Valid states are "idle", "failure", "association",
                        "configuration" and "ready".
 
+                       Also "login" and "online" states are used. The
+                       state "online" signals that an Internet connection
+                       is available and has been verified.
+
                string Error [readonly]
 
                        The service error status details.
@@ -147,12 +161,17 @@ Properties        string State [readonly]
 
                string Mode [readonly]
 
-                       If the service type is WiFi, then this property is
-                       present and contains the mode of the network. The
-                       possible values are "managed" or "adhoc".
+                       If the service type is WiFi or Cellular, then this
+                       property is present and contains the mode of the
+                       network.
 
-                       This property might be only present for WiFi
-                       services.
+                       For WiFi services the possible values are "managed"
+                       and "adhoc". For Cellular services it describes the
+                       network technology. Possible values are "gprs", "edge"
+                       and "umts".
+
+                       This property might be only present for WiFi and
+                       Cellular services.
 
                string Security [readonly]
 
@@ -160,7 +179,9 @@ Properties  string State [readonly]
                        present and contains the security method or key
                        management setting.
 
-                       Possible values are "none", "wep", "wpa" and "rsn".
+                       Possible values are "none", "wep", "psk" and
+                       also "ieee8021x". Alternate values for "psk"
+                       can also be "wpa" and "rsn".
 
                        This property might be only present for WiFi
                        services.
@@ -199,21 +220,191 @@ Properties       string State [readonly]
                        Will be true if a cable is plugged in or the user
                        selected and successfully connected to this service.
 
-                       Setting this property to true has no effect at all
-                       and setting it to false is similar to the Remove()
-                       method. So for now it will be considered a read
-                       only property.
+                       This value is automatically changed and to revert
+                       it back to false the Remove() method needs to be
+                       used.
 
-               boolean AutoConnect [readonly]
+               boolean Immutable [readonly]
+
+                       This value will be set to true if the service is
+                       configured externally via a configuration file.
+
+                       The only valid operation are Connect() and of
+                       course Disconnect(). The Remove() method will
+                       result in an error.
+
+               boolean AutoConnect [readwrite]
 
                        If set to true, this service will auto-connect
                        when not other connection is available.
 
-               string IPv4.Method [readwrite]
+                       For favorite services it is possible to change
+                       this value to prevent or permit automatic
+                       connection attempts.
+
+               boolean SetupRequired [readonly]
+
+                       If the service is Cellular, then this property
+                       indicates that some extra setup steps are required.
+
+                       In most cases it is required to fill in the APN
+                       details.
+
+               string APN [readwrite]
+
+                       If the service is Cellular, then this property
+                       contains the APN details.
+
+                       The APN is network provider specific and even
+                       sometimes data plan specific. Possible examples
+                       are "isp.cingular" or "internet.t-mobile".
+
+               string MCC [readonly]
+
+                       If the service is Cellular, then this property
+                       contains the Mobile Country Code.
+
+               string MNC [readonly]
+
+                       If the service is Cellular, then this property
+                       contains the Mobile Network Code.
+
+               boolean Roaming [readonly]
+
+                       This property indicates if this service is roaming.
+
+                       In the case of Cellular services this normally
+                       indicates connections to a foreign provider when
+                       traveling abroad.
+
+               array{string} Nameservers [readonly]
+
+                       The list of currently active nameservers for this
+                       service. If the server is not in READY, LOGIN or
+                       ONLINE state than this list will be empty.
+
+                       Global nameservers are automatically added to this
+                       list. The array represents a sorted list of the
+                       current nameservers. The first one has the highest
+                       priority and is used by default.
+
+                       When using DHCP this array represents the nameservers
+                       provided by the network. In case of manual settings,
+                       the ones from Nameservers.Configuration are used.
+
+               array{string} Nameservers.Configuration [readwrite]
+
+                       The list of manually configured domain name
+                       servers. Some 3G networks don't provide correct
+                       name servers and this allows for an override.
+
+                       This array is sorted by priority and the first
+                       entry in the list represents the nameserver with
+                       the highest priority.
+
+                       When using manual configuration and no global
+                       nameservers are configured, then it is useful
+                       to configure this setting.
+
+                       Changes to the domain name servers can be done
+                       at any time. It will not cause a disconnect of
+                       the service. However there might be small window
+                       where name resolution might fail.
+
+               array{string} Domains [readonly]
+
+                       The list of currently used search domains.
+
+               array{string} Domains.Configuration [readwrite]
+
+                       The list of manually configured search domains.
+
+               dict IPv4 [readonly]
+
+                       string Method [readonly]
+
+                               Possible values are "dhcp", "manual"
+                               and "off".
+
+                               The value "fixed" indicates an IP address
+                               that can not be modified. For example
+                               cellular networks return fixed information.
+
+                       string Address [readonly]
+
+                               The current configured IPv4 address.
+
+                       string Netmask [readonly]
+
+                               The current configured IPv4 netmask.
+
+                       string Gateway [readonly]
+
+                               The current configured IPv4 gateway.
+
+               dict IPv4.Configuration [readwrite]
+
+                       Same values as IPv4 property. The IPv4 represents
+                       the actual system configuration while this allows
+                       user configuration.
+
+                       Changing these settings will cause a state change
+                       of the service. The service will become unavailable
+                       until the new configuration has been successfully
+                       installed.
+
+               dict Proxy [readonly]
+
+                       string Method [readonly]
+
+                               Possible values are "direct", "auto",
+                               "manual" and "auto-config".
+
+                               If the DHCP server provides an automatic
+                               configuration URL, then this value is set
+                               to "auto-config". The PAC file will be
+                               referenced by the URL value.
+
+                               If no automatic configuration is available,
+                               then "direct" is set.
+
+                               The values "auto" and "manual" are not yet
+                               supported.
+
+                       string URL [readonly]
+
+                               Automatic proxy configuration URL.
+
+               dict Ethernet [readonly]
+
+                       string Method [readonly]
+
+                               Possible values are "auto" and "manual".
+
+                       string Interface [readonly]
+
+                               Interface name (for example eth0).
+
+                       string Address [readonly]
+
+                               Ethernet device address (MAC address).
+
+                       uint16 MTU [readonly]
+
+                               The Ethernet MTU (default is 1500).
+
+                       uint16 Speed [readonly]
+
+                               Selected speed of the line.
+
+                               This information might not always be
+                               available.
+
+                       string Duplex [readonly]
 
-                       The IPv4 configuration method. Possible values here
-                       are "dhcp" and "static".
+                               Selected duplex settings of the line.
 
-               string IPv4.Address [readwrite]
+                               Possible values are "half" and "full".
 
-                       The current configured IPv4 address.
+                               This information might not always be
+                               available.