summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Wagner <daniel.wagner@bmw-carit.de>2012-09-18 08:27:46 (GMT)
committerDaniel Wagner <daniel.wagner@bmw-carit.de>2012-09-27 08:28:27 (GMT)
commit9d444c2e10fafc8a1ff96b3b46948eb030aec0af (patch)
tree2003312b8df697adb47dd581e34d6e999cd9ccb6 /doc
parent2c2fd6ef08fab323ebd20762f87cd3c8529b7c5e (diff)
downloadconnman-9d444c2e10fafc8a1ff96b3b46948eb030aec0af.zip
connman-9d444c2e10fafc8a1ff96b3b46948eb030aec0af.tar.gz
connman-9d444c2e10fafc8a1ff96b3b46948eb030aec0af.tar.bz2
session: Remove AvoidHandover documentation
The AvoidHandover boolean was there to fine tune the selection algorithm in ConnMan. It was never implemented. Let's get rid for the time beeing. If there is a real need for it we should implemented this setting through the configuration plugin.
Diffstat (limited to 'doc')
-rw-r--r--doc/session-api.txt21
1 files changed, 0 insertions, 21 deletions
diff --git a/doc/session-api.txt b/doc/session-api.txt
index df1b4f2..98051a6 100644
--- a/doc/session-api.txt
+++ b/doc/session-api.txt
@@ -144,27 +144,6 @@ Settings boolean State [readonly]
certain bearers such as Wifi with a fallback to any
other available bearer.
- boolean AvoidHandover [readwrite]
-
- By default this setting is false. It can be used
- to indicate that a handover is currently not a good
- idea. However no connection is guaranteed. So a
- handover can happen anyway. This is just an indication
- that the application would like to avoid it right now.
-
- It is a bad idea to always enable this settings and
- actually it will be reset after a while to avoid
- congestion.
-
- Main use case it is for application that are currently
- doing a specific tasks that it prefers to finish
- before allowing handovers again. An example would
- be synchronization.
-
- Never the less application needs to be aware that
- handovers can happen at any time even if this is
- set to true.
-
string ConnectionType [readwrite]
This is used to indicate which connection is requested