summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Wagner <daniel.wagner@bmw-carit.de>2012-08-13 08:40:16 (GMT)
committerPatrik Flykt <patrik.flykt@linux.intel.com>2012-08-30 09:56:30 (GMT)
commit0ef023c37faf21a16d2e4e7126abef29d6eb7ee4 (patch)
tree2708bd24a0e811dd77effcb65a4aa9b3c7717d08 /doc
parent598bce15850efccb2a10d1bff51f606c2d2086b6 (diff)
downloadconnman-0ef023c37faf21a16d2e4e7126abef29d6eb7ee4.tar.gz
connman-0ef023c37faf21a16d2e4e7126abef29d6eb7ee4.tar.xz
session: Move IdleTimeout to Technology API
Having an IdleTimeout per Session is not really reasonable. It is hard to define the right behavoir if the timeouts differ per Session. Doing this per technology is easier to understand and also makes sense when no Session is used. IdleTimeout is only documented here, it's not yet implemented.
Diffstat (limited to 'doc')
-rw-r--r--doc/session-api.txt9
-rw-r--r--doc/technology-api.txt8
2 files changed, 8 insertions, 9 deletions
diff --git a/doc/session-api.txt b/doc/session-api.txt
index e19c6bf..90002ba 100644
--- a/doc/session-api.txt
+++ b/doc/session-api.txt
@@ -241,15 +241,6 @@ Settings string Bearer [readonly]
settings becomes available becomes available. Using
this feature it is also easy to avoid congestion.
- uint32 IdleTimeout [readwrite]
-
- If the system is idle for given period then it should
- go offline.
-
- If the timeout is 0, this feature is disabled. If
- different values are provided by several session object
- the longest interval is taken as timeout value.
-
boolean EmergencyCall [readwrite]
Boolean representing the emergency mode of the
diff --git a/doc/technology-api.txt b/doc/technology-api.txt
index 6429776..9fe66b3 100644
--- a/doc/technology-api.txt
+++ b/doc/technology-api.txt
@@ -93,3 +93,11 @@ Properties boolean Powered [readwrite]
This property is only valid for the WiFi technology,
and is then mapped to the WPA pre-shared key clients
will have to use in order to establish a connection.
+
+ uint32 IdleTimeout [readwrite] [experimental]
+
+ If the technology is idle for given period then it
+ will go offline if no Service with this technology
+ has AutoConnect set to True.
+
+ If the timeout is 0, this feature is disabled.