summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Wagner <daniel.wagner@bmw-carit.de>2012-08-13 08:40:32 (GMT)
committerPatrik Flykt <patrik.flykt@linux.intel.com>2012-08-30 10:05:35 (GMT)
commitcf3693666eaec35913874aeee297160163d56f65 (patch)
tree10c76b8ddce23eebbaca0d3d76ef3181642e551f /doc
parent04728bfe16909830ff5d6d27afee172ac07a104a (diff)
downloadconnman-cf3693666eaec35913874aeee297160163d56f65.tar.gz
connman-cf3693666eaec35913874aeee297160163d56f65.tar.xz
session: Reorder D-Bus documentation
Reorder and group the settings, first the read only values and then the ones which can be changed.
Diffstat (limited to 'doc')
-rw-r--r--doc/session-api.txt81
1 files changed, 41 insertions, 40 deletions
diff --git a/doc/session-api.txt b/doc/session-api.txt
index 074fd7b..df1b4f2 100644
--- a/doc/session-api.txt
+++ b/doc/session-api.txt
@@ -84,34 +84,7 @@ Methods void Destroy()
to be sent. Some changes might cause the session to
be moved to offline state.
-Settings string Bearer [readonly]
-
- This indicates the current bearer that is used
- for this session. Or an empty string if no bearer
- 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.
-
- (This setting will be removed when the unique process
- identifaction problem is solved.)
-
- boolean State [readonly]
+Settings boolean State [readonly]
This indicates if the connection is disconnected,
connected or online. It is updated according to the
@@ -137,6 +110,26 @@ Settings string Bearer [readonly]
It should only be used for displaying it in the UI
and not for getting hold on session object.
+ string Bearer [readonly]
+
+ This indicates the current bearer that is used
+ for this session. Or an empty string if no bearer
+ if available.
+
+ string Interface [readonly]
+
+ Interface name used by the service object to connect.
+ This name can be used for SO_BINDTODEVICE in the
+ application.
+
+ dict IPv4 [readonly]
+
+ Current IPv4 configuration.
+
+ dict IPv6 [readonly]
+
+ Current IPv6 configuration.
+
array{string} AllowedBearers [readwrite]
A list of bearers that can be used for this session.
@@ -151,14 +144,6 @@ Settings string Bearer [readonly]
certain bearers such as Wifi with a fallback to any
other available bearer.
- dict IPv4 [readonly]
-
- Current IPv4 configuration.
-
- dict IPv6 [readonly]
-
- Current IPv6 configuration.
-
boolean AvoidHandover [readwrite]
By default this setting is false. It can be used
@@ -180,8 +165,24 @@ Settings string Bearer [readonly]
handovers can happen at any time even if this is
set to true.
- string Interface [readonly]
+ 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.
+
+ (This setting will be removed when the unique process
+ identifaction problem is solved.)
- Interface name used by the service object to connect.
- This name can be used for SO_BINDTODEVICE in the
- application.