Fixed connman crash due to memory corruption

[platform/upstream/connman.git] / doc / session-api.txt

diff --git a/doc/session-api.txt b/doc/session-api.txt
old mode 100644 (file)
new mode 100755 (executable)
index 14ff76b..3aac535
--- a/doc/session-api.txt
+++ b/doc/session-api.txt
@@ -84,7 +84,7 @@ Methods               void Destroy()
                        to be sent. Some changes might cause the session to
                        be moved to offline state.
 
-Settings       boolean State [readonly]
+Settings       string State [readonly]
 
                        This indicates if the connection is disconnected,
                        connected or online. It is updated according to the
@@ -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
@@ -171,5 +180,5 @@ Settings    boolean State [readonly]
                        session with 'any' will be created.
 
                        (This setting will be removed when the unique process
-                       identifaction problem is solved.)
+                       identification problem is solved.)