path: root/doc
diff options
authorDaniel Wagner <>2012-09-20 14:47:14 (GMT)
committerDaniel Wagner <>2012-09-27 08:28:28 (GMT)
commit4b1ca2369056fcffa5278372004e0926a08c9c04 (patch)
treefdaa91c53db3ac5cfa6c277edc687a2b26e31c1a /doc
parent17f13be5db7f35d9c5c034e87c0920fe6143601d (diff)
session: Update ConnnectionType documentation
Diffstat (limited to 'doc')
1 files changed, 13 insertions, 5 deletions
diff --git a/doc/session-api.txt b/doc/session-api.txt
index 98051a6..14ff76b 100644
--- a/doc/session-api.txt
+++ b/doc/session-api.txt
@@ -148,19 +148,27 @@ Settings boolean State [readonly]
This is used to indicate which connection is requested
from the session. The state of the session will be
- updated accordingly. Values can be nothing, 'local' or
- 'internet'.
+ updated accordingly. Values can be 'local',
+ 'internet' or 'any'.
'local' means the session requests to be connected,
but does not require specifically to be online.
Therefore State property will be set to 'connected' if
underlying service gets ready and/or online.
'online' means the session requests to be connected,
and online. State property will never get 'connected'
but instead will switch to 'online' if underlying
service gets online.
- No value means the session requests any kind of
- connection and the state will be updated on all steps,
- 'connected' and 'online'. This is the default value.
+ 'any' means either 'local' or 'internet'.
+ Invalid values will be ignored and removed. An
+ empty ConnectionType is an invalid configuration.
+ When a session is created and the provided settings
+ dictionary does not contain ConnectionType, a default
+ session with 'any' will be created.
(This setting will be removed when the unique process
identifaction problem is solved.)