Add additionals statistics counters
[framework/connectivity/connman.git] / doc / counter-api.txt
1 Counter hierarchy
2 =================
3
4 Service         unique name
5 Interface       org.moblin.connman.Counter
6 Object path     freely definable
7
8 Methods         void Release()
9
10                         This method gets called when the service daemon
11                         unregisters the counter. A counter can use it to do
12                         cleanup tasks. There is no need to unregister the
13                         counter, because when this method gets called it has
14                         already been unregistered.
15
16                 Usage(object service, dict)
17
18                         This signal indicates a change in the counter values
19                         for the service object. The counter is reset by calling
20                         the service ResetCounters method.
21
22                         The dict argument contains following entries:
23
24                                 RX.Packets
25
26                                         Total number of packets received.
27
28                                 TX.Bytes
29
30                                         Total number of packets sent.
31
32                                 RX.Bytes
33
34                                         Total number of bytes received.
35
36                                 TX.Bytes
37
38                                         Total number of bytes sent.
39
40                                 RX.Errors
41
42                                         Total number of erronous packets
43                                         received.
44
45                                 TX.Errors
46
47                                         Total number of erronous packets
48                                         sent.
49
50                                 RX.Dropped
51
52                                         Total number of dropped packets
53                                         while receiving.
54
55                                 TX.Dropped
56
57                                         Total number of dropped packets
58                                         while sending.
59
60                                 Time
61                                         Total number of seconds online.