session: Update ConnnectionType documentation
authorDaniel Wagner <daniel.wagner@bmw-carit.de>
Thu, 20 Sep 2012 14:47:14 +0000 (16:47 +0200)
committerDaniel Wagner <daniel.wagner@bmw-carit.de>
Thu, 27 Sep 2012 08:28:28 +0000 (10:28 +0200)
doc/session-api.txt

index 98051a6e52f73ef10cab5281a04d9a0885acb858..14ff76b21abee849d967e5f97047a2832c870c14 100644 (file)
@@ -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.)