---
doc/session-api.txt | 85 ++++++++++++++++++++++++++++++++++++++------------
1 files changed, 64 insertions(+), 21 deletions(-)
diff --git a/doc/session-api.txt b/doc/session-api.txt
index 0bc93fc..ca52254 100644
--- a/doc/session-api.txt
+++ b/doc/session-api.txt
@@ -87,25 +87,56 @@ Methods void Destroy()
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
+ for this session. It is a valid info only when
+ the session is connected/online. Therefore it
+ will be part of the notification content only
+ when the session reaches such useful state.
+
+ 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.
+ Once the state gets updated to a valid one - connected
+ or online - the useful informations: Name, Interface,
+ Bearer, Ipv4, Ipv6 will be provided also.
+ Once the state gets disconnected, it is up to the
+ session owner to forget about this informations which
+ are no more relevant.
+
boolean Priority [readwrite]
This allows a session to mark itself as priority or
@@ -141,6 +172,10 @@ Settings string Bearer [readonly]
The Service name to which the system is connected.
It should only be used for displaying it in the UI
and not for getting hold on session object.
+ It is a valid info only when the session is
+ connected/online. Therefore it will be part of the
+ notification content only when the session reaches
+ such useful state.
array{string} AllowedBearers [readwrite]
@@ -158,15 +193,19 @@ 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.
+ It is a valid info only when the session is
+ connected/online. Therefore it will be part of the
+ notification content only when the session reaches
+ such useful state.
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.
+ It is a valid info only when the session is
+ connected/online. Therefore it will be part of the
+ notification content only when the session reaches
+ such useful state.
boolean AvoidHandover [readwrite]
@@ -286,6 +325,10 @@ Settings string Bearer [readonly]
Interface name used by the service object to connect.
This name can be used for SO_BINDTODEVICE in the
application.
+ It is a valid info only when the session is
+ connected/online. Therefore it will be part of the
+ notification content only when the session reaches
+ such useful state.
uint32 SessionMarker [readonly]
--
1.7.8.4
_______________________________________________
connman mailing list
[email protected]
http://lists.connman.net/listinfo/connman
