diff options
| author | Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com> | 2012-02-15 10:19:46 +0200 |
|---|---|---|
| committer | Patrik Flykt <patrik.flykt@linux.intel.com> | 2012-02-28 13:17:22 +0200 |
| commit | 1514d2251c724f4e402cfad2b811ff62552d8bbd (patch) | |
| tree | 6a393506dbe8c14c749fd89be82d0953d7237163 /doc | |
| parent | 0498e18e84cf56a28ed0ebc72ad0b42071fa8efa (diff) | |
| download | connman-1514d2251c724f4e402cfad2b811ff62552d8bbd.tar.gz connman-1514d2251c724f4e402cfad2b811ff62552d8bbd.tar.bz2 connman-1514d2251c724f4e402cfad2b811ff62552d8bbd.zip | |
doc: updated session api documentation
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/session-api.txt | 58 |
1 files changed, 38 insertions, 20 deletions
diff --git a/doc/session-api.txt b/doc/session-api.txt index 0bc93fce..e19c6bfe 100644 --- a/doc/session-api.txt +++ b/doc/session-api.txt @@ -88,20 +88,42 @@ Settings string Bearer [readonly] This indicates the current bearer that is used for this session. Or an empty string if no bearer - is available. - - boolean Online [readonly] - - This indicates if the connection is online or - offline. - - This maps to the online service state. And it is - only valid for the selected bearer configuration. - Otherwise it will be reported as offline even if - the global state would be online. - - In addition the Online settings notification might - not happen right away. Notifications of online state + if available. + + string ConnectionType [readwrite] + + 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'. + '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. + + boolean State [readonly] + + This indicates if the connection is disconnected, + connected or online. It is updated according to the + selected ConnectionType. The session will not be + in a useful shape (i.e.: providing a network connection + to the owner) until its State gets updated to connected + and/or online. + + This maps to the useful port of the service state. + And it is only valid for the selected bearer + configuration. Otherwise it will be reported as + disconnected even if connected services are present. + + In addition the State settings notification might + not happen right away. Notifications of this state can be delayed based on the speed of the bearer. It is done to avoid congestion on bearers like cellular etc. @@ -158,15 +180,11 @@ Settings string Bearer [readonly] dict IPv4 [readonly] - Current IPv4 configuration. This settings is only - valid when online is true as well. Otherwise an - empty dictionary is reported. + Current IPv4 configuration. dict IPv6 [readonly] - Current IPv6 configuration. This setting is only - valid when online is true as well. Otherwise an - empty dictionary is reported. + Current IPv6 configuration. boolean AvoidHandover [readwrite] |