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

index 14ff76b..aab7a9a 100644 (file)
@@ -141,9 +141,18 @@ Settings   boolean State [readonly]
                        entries in this list.
 
                        Also "*" matches any bearer. This is usefull to prefer
-                       certain bearers such as Wifi with a fallback to any
+                       certain bearers such as 'wifi' with a fallback to any
                        other available bearer.
 
+                       Invalid bearer names will be ignored and removed
+                       from the list. And empty AllowedBearers will
+                       not match to any bearer, therefore the session
+                       will never go online.
+
+                       When a session is created and the provided settings
+                       dictionary does not contain AllowedBearers, a default
+                       session with "*" will be created.
+
                string ConnectionType [readwrite]
 
                        This is used to indicate which connection is requested