summaryrefslogtreecommitdiff
path: root/doc/counter-api.txt
blob: 32411d57976d8aaa8065e4aa31a528eb924a9365 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
Counter hierarchy
=================

Service		unique name
Interface	net.connman.Counter
Object path	freely definable

Methods		void Release()

			This method gets called when the service daemon
			unregisters the counter. A counter can use it to do
			cleanup tasks. There is no need to unregister the
			counter, because when this method gets called it has
			already been unregistered.

		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.

			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

					Total number of packets received.

				TX.Bytes

					Total number of packets sent.

				RX.Bytes

					Total number of bytes received.

				TX.Bytes

					Total number of bytes sent.

				RX.Errors

					Total number of erronous packets
					received.

				TX.Errors

					Total number of erronous packets
					sent.

				RX.Dropped

					Total number of dropped packets
					while receiving.

				TX.Dropped

					Total number of dropped packets
					while sending.

				Time

					Total number of seconds online.