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 string State [readonly]
This indicates if the connection is disconnected,
connected or online. It is updated according to the
It should only be used for displaying it in the UI
and not for getting hold on session object.
- array{string} AllowedBearers [readwrite]
+ string Bearer [readonly]
- A list of bearers that can be used for this session.
- In general this list should be empty to indicate that
- any bearer is acceptable.
+ This indicates the current bearer that is used
+ for this session. Or an empty string if no bearer
+ if available.
- The order of the entries in AllowedBearers matters.
- The services are sorted in the order of the bearer
- entries in this list.
+ string Interface [readonly]
- Also "*" matches any bearer. This is usefull to prefer
- certain bearers such as Wifi with a fallback to any
- other available bearer.
+ Interface name used by the service object to connect.
+ This name can be used for SO_BINDTODEVICE in the
+ application.
dict IPv4 [readonly]
Current IPv6 configuration.
- boolean AvoidHandover [readwrite]
+ array{string} AllowedBearers [readwrite]
- By default this setting is false. It can be used
- to indicate that a handover is currently not a good
- idea. However no connection is guaranteed. So a
- handover can happen anyway. This is just an indication
- that the application would like to avoid it right now.
+ A list of bearers that can be used for this session.
+ In general this list should be empty to indicate that
+ any bearer is acceptable.
- It is a bad idea to always enable this settings and
- actually it will be reset after a while to avoid
- congestion.
+ The order of the entries in AllowedBearers matters.
+ The services are sorted in the order of the bearer
+ entries in this list.
- Main use case it is for application that are currently
- doing a specific tasks that it prefers to finish
- before allowing handovers again. An example would
- be synchronization.
+ Also "*" matches any bearer. This is usefull to prefer
+ certain bearers such as 'wifi' with a fallback to any
+ other available bearer.
- Never the less application needs to be aware that
- handovers can happen at any time even if this is
- set to true.
+ Invalid bearer names will be ignored and removed
+ from the list. And empty AllowedBearers will
+ not match to any bearer, therefore the session
+ will never go online.
- string RoamingPolicy [readwrite]
+ When a session is created and the provided settings
+ dictionary does not contain AllowedBearers, a default
+ session with "*" will be created.
- The allowed roaming behavior.
+ string ConnectionType [readwrite]
- Valid policies are "national", "international",
- "default", "always" and "forbidden".
+ This is used to indicate which connection is requested
+ from the session. The state of the session will be
+ updated accordingly. Values can be 'local',
+ 'internet' or 'any'.
- "national" allows roaming within a country.
- "international" allows roaming in a country and
- between countries.
+ '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.
- "default" is used to tell the Session to use
- the global roaming setting.
+ '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.
- "always" will overwrite the default "forbidden"
- value which is useful for emergency application.
- This value will be protected by additional PolicyKit
- rule.
+ 'any' means either 'local' or 'internet'.
- Default value is "forbidden".
+ Invalid values will be ignored and removed. An
+ empty ConnectionType is an invalid configuration.
- string Interface [readonly]
+ When a session is created and the provided settings
+ dictionary does not contain ConnectionType, a default
+ session with 'any' will be created.
+
+ (This setting will be removed when the unique process
+ identification problem is solved.)
- Interface name used by the service object to connect.
- This name can be used for SO_BINDTODEVICE in the
- application.