Added support to get country-code.
[platform/upstream/connman.git] / doc / counter-api.txt
old mode 100644 (file)
new mode 100755 (executable)
index 28ec662..c0d9b76
@@ -2,7 +2,7 @@ Counter hierarchy
 =================
 
 Service                unique name
-Interface      org.moblin.connman.Counter
+Interface      net.connman.Counter
 Object path    freely definable
 
 Methods                void Release()
@@ -13,13 +13,21 @@ Methods             void Release()
                        counter, because when this method gets called it has
                        already been unregistered.
 
-               void Usage(object service, dict)
+               void Usage(object service, dict home, dict roaming)
 
                        This signal indicates a change in the counter values
                        for the service object. The counter is reset by calling
                        the service ResetCounters method.
 
-                       The dict argument contains following entries:
+                       When registering a new counter this method will be
+                       called once with all details for "home" and "roaming"
+                       counters filled in. Every further method call will
+                       only include the changed values.
+
+                       When "home" counter is active, then "roaming" counter
+                       will contain an empty dictionary and vise-versa.
+
+                       The dictionary argument contains the following entries:
 
                                RX.Packets
 
@@ -39,12 +47,12 @@ Methods             void Release()
 
                                RX.Errors
 
-                                       Total number of erronous packets
+                                       Total number of erroneous packets
                                        received.
 
                                TX.Errors
 
-                                       Total number of erronous packets
+                                       Total number of erroneous packets
                                        sent.
 
                                RX.Dropped