summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Wagner <daniel.wagner@bmw-carit.de>2011-04-06 15:55:16 +0200
committerDaniel Wagner <daniel.wagner@bmw-carit.de>2011-04-07 16:35:20 +0200
commit09c48519ad3ff07acd01ba9c037271c368989000 (patch)
tree1ccb91cde95c6dee87a5df68c807506ec53738b8 /doc
parent16c04696ff458c57b054cf3c8ab68c9d83880430 (diff)
downloadconnman-09c48519ad3ff07acd01ba9c037271c368989000.tar.gz
connman-09c48519ad3ff07acd01ba9c037271c368989000.tar.bz2
connman-09c48519ad3ff07acd01ba9c037271c368989000.zip
session: Rename the Realtime flag to Priority
Also change the meaning of the flag, back to the original proposal from Marcel Holtmann.
Diffstat (limited to 'doc')
-rw-r--r--doc/session-api.txt27
1 files changed, 24 insertions, 3 deletions
diff --git a/doc/session-api.txt b/doc/session-api.txt
index 019e2448..e20449b7 100644
--- a/doc/session-api.txt
+++ b/doc/session-api.txt
@@ -105,12 +105,33 @@ Settings string Bearer [readonly]
can be delayed based on the speed of the bearer. It
is done to avoid congestion on bearers like 3G etc.
- boolean Realtime [readwrite]
+ boolean Priority [readwrite]
- This indicates if the application uses realtime traffic.
+ This allows a session to mark itself as priority or
+ not. In general application are not allowed to make
+ themselves more important than others.
+
+ The priority handling is done internally by usage
+ and first come, first serve order. By default this
+ settings is of course false.
+
+ Internally there can be different priorities for
+ different application, but these are defined by a
+ configuration file and not via this interface.
+
+ An application that calls the method to connect
+ a session is preferred over other sessions. This
+ priority value is more for application that want to
+ push themselves up in the asychronization notification
+ queue once a bearer becomes online.
+
+ This actual priority order also depends on the
+ allowed bearers and other factors. This is setting
+ is just a little indicator of one application being
+ notified before another one.
For example a streaming session should set the
- realtime value. As soon as realtime data is involved
+ priority value. As soon as realtime data is involved
then this should be set. An email client should not
set this value.