Imported Upstream version 1.38

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

diff --git a/doc/session-api.txt b/doc/session-api.txt
index 3aac535..8bfcf6b 100644 (file)
--- a/doc/session-api.txt
+++ b/doc/session-api.txt
@@ -140,7 +140,7 @@ Settings    string State [readonly]
                        The services are sorted in the order of the bearer
                        entries in this list.
 
-                       Also "*" matches any bearer. This is usefull to prefer
+                       Also "*" matches any bearer. This is useful to prefer
                        certain bearers such as 'wifi' with a fallback to any
                        other available bearer.
 
@@ -182,3 +182,37 @@ Settings   string State [readonly]
                        (This setting will be removed when the unique process
                        identification problem is solved.)
 
+               string AllowedInterface [readwrite] [experimental]
+
+                       This field is used to bind a session to a specific
+                       network interface. If this field is empty, the first
+                       interface from a list of available ones will be used.
+                       Also "*" string matches any interface.
+
+                       Only one interface may be specified.
+
+                       If a specified network interface is not available
+                       (e.g. because AllowedBearers filters it out), the
+                       session will not go online.
+
+               boolean SourceIPRule [readwrite] [experimental]
+
+                       If set to true the session will create source IP
+                       address rule in the firewall, which redirects traffic
+                       to that session's routing table.
+
+                       Each session maintains a dedicated routing table, with
+                       a default route. When the source IP rule is enabled,
+                       an application can select which session/interface to
+                       send traffic on, using bind-before-connect mechanism.
+
+               string ContextIdentifier [readwrite] [experimental]
+
+                       The application can provide an identifier for a
+                       session. If an application runs several session
+                       at the same time, the additional information
+                       can be used by ConnMan to assign different
+                       bearers according the identifier. For example
+                       a web browser creates per tab a session. For
+                       each session a different should bearer be
+                       assigned.