summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2012-04-16 11:31:32 +0200
committerMarcel Holtmann <marcel@holtmann.org>2012-04-17 14:39:30 +0200
commitdd4d09dffb2bc3a1c39a272a1af7168e9e224a90 (patch)
treefd55dd4ae77add80e5ca157e943c13bf1de6c017 /doc
parent340e4db0b748a6b581f0655fddeaec0cea7c0401 (diff)
downloadconnman-dd4d09dffb2bc3a1c39a272a1af7168e9e224a90.tar.gz
connman-dd4d09dffb2bc3a1c39a272a1af7168e9e224a90.tar.bz2
connman-dd4d09dffb2bc3a1c39a272a1af7168e9e224a90.zip
doc: Update global state property details
Diffstat (limited to 'doc')
-rw-r--r--doc/manager-api.txt22
1 files changed, 17 insertions, 5 deletions
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index 166d58aa..1f4663e2 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -186,12 +186,24 @@ Signals TechnologyAdded(object path, dict properties)
Properties string State [readonly]
The global connection state of a system. Possible
- values are "online" if at least one connection exists
- and "offline" if no device is connected.
+ values are "offline", "idle", "ready" and "online".
- In certain situations the state might change to
- the value "connected". This can only be seen if
- previously no connection was present.
+ If the device is in offline mode, the value "offline"
+ indicates this special global state. It can also be
+ retrieved via the OfflineMode property, but is kept
+ here for consistency and to differentiate from "idle".
+
+ The states "idle", "ready" and "online" match to
+ states from the services. If no service is in
+ either "ready" or "online" state it will indicate
+ the "idle" state.
+
+ If at least one service is in "ready" state and no
+ service is in "online" state, then it will indicate
+ the "ready" state.
+
+ When at least one service is in "online" state,
+ this property will indicate "online" as well.
boolean OfflineMode [readwrite]