Update counter API documentation

[framework/connectivity/connman.git] / doc / service-api.txt

diff --git a/doc/service-api.txt b/doc/service-api.txt
index 149e9d7..a3e3c10 100644 (file)
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -104,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
@@ -300,6 +306,11 @@ Properties string State [readonly]
                        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.
@@ -315,6 +326,10 @@ Properties string State [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.
@@ -333,6 +348,11 @@ Properties string State [readonly]
                        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]