summaryrefslogtreecommitdiff
path: root/doc/manager-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2010-07-23 20:01:49 -0700
committerMarcel Holtmann <marcel@holtmann.org>2010-07-23 20:01:49 -0700
commit07a94078b2555852355b10f56c28da55d4fe74dc (patch)
treea5ab522c4c0df9df0bc017de4d97a5ae2233cecd /doc/manager-api.txt
parentc4ece974f8fe47f5a8de2afe242546bf19b33731 (diff)
downloadconnman-07a94078b2555852355b10f56c28da55d4fe74dc.tar.gz
connman-07a94078b2555852355b10f56c28da55d4fe74dc.tar.bz2
connman-07a94078b2555852355b10f56c28da55d4fe74dc.zip
Update RegisterCounter method parameters
Diffstat (limited to 'doc/manager-api.txt')
-rw-r--r--doc/manager-api.txt20
1 files changed, 15 insertions, 5 deletions
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index 40dac019..20ceb703 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -129,14 +129,24 @@ Methods dict GetProperties()
Possible Errors: [service].Error.InvalidArguments
- void RegisterCounter(object path, uint32 interval)
+ void RegisterCounter(object path, uint32 accuracy, uint32 period)
Register a new counter for user notifications.
- If the interval is zero then no timer for updates
- will be started. Only kernel events can then
- trigger updates. Otherwise the kernel will be
- polled every n seconds for an update.
+ The accuracy is specified in kilo-bytes and defines
+ a threshold for counter updates. Together with the
+ period value it defines how often user space needs
+ to be updated. The period value is in seconds.
+
+ This interface is not meant for time tracking. If
+ the time needs to be tracked down to the second, it
+ is better to have a real timer running inside the
+ application than using this interface.
+
+ Also getting notified for every kilo-byte is a bad
+ choice (even if the interface supports it). Something
+ like 10 kilo-byte units or better 1 mega-byte seems
+ to be a lot more reasonable and better for the user.
Possible Errors: [service].Error.InvalidArguments