2 Interface net.connman.Notification
3 Object path freely definable
7 This method gets called when the service daemon
8 unregisters the session. A counter can use it to do
9 cleanup tasks. There is no need to unregister the
10 session, because when this method gets called it has
11 already been unregistered.
13 void Update(dict settings)
15 Sends an update of changed settings. Only settings
16 that are changed will be included.
18 Initially on every session creation this method is
19 called once to inform about the current settings.
23 Interface net.connman.Session
26 Methods void Destroy()
28 Close the current session. This is similar to
29 DestroySession method on the manager interface. It
30 is just provided for convenience depending on how
31 the application wants to track the session.
35 If not connected, then attempt to connect this
38 The usage of this method depends a little bit on
39 the model of the application. Some application
40 should not try to call Connect on any session at
41 all. They should just monitor if it becomes online
44 Others might require an active connection right now.
45 So for example email notification should only check
46 for new emails when a connection is available. However
47 if the user presses the button for get email or wants
48 to send an email it should request to get online with
51 Depending on the bearer settings the current service
52 is used or a new service will be connected.
54 This method returns immediately after it has been
55 called. The application is informed through the update
56 notification about the state of the session.
58 It is also not guaranteed that a session stays online
59 after this method call. It can be taken offline at any
60 time. This might happen because of idle timeouts or
63 It is safe to call this method multiple times. The
64 actual usage will be sorted out for the application.
68 This method indicates that the current session does
69 not need a connection anymore.
71 This method returns immediately. The application is
72 informed through the update notification about the
75 void Change(string name, variant value)
77 Change the value of certain settings. Not all
78 settings can be changed. Normally this should not
79 be needed or an extra session should be created.
80 However in some cases it makes sense to change
81 a value and trigger different behavior.
83 A change of a setting will cause an update notification
84 to be sent. Some changes might cause the session to
85 be moved to offline state.
87 Settings boolean State [readonly]
89 This indicates if the connection is disconnected,
90 connected or online. It is updated according to the
91 selected ConnectionType. The session will not be
92 in a useful shape (i.e.: providing a network connection
93 to the owner) until its State gets updated to connected
96 This maps to the useful port of the service state.
97 And it is only valid for the selected bearer
98 configuration. Otherwise it will be reported as
99 disconnected even if connected services are present.
101 In addition the State settings notification might
102 not happen right away. Notifications of this state
103 can be delayed based on the speed of the bearer. It
104 is done to avoid congestion on bearers like cellular
107 string Name [readonly]
109 The Service name to which the system is connected.
110 It should only be used for displaying it in the UI
111 and not for getting hold on session object.
113 string Bearer [readonly]
115 This indicates the current bearer that is used
116 for this session. Or an empty string if no bearer
119 string Interface [readonly]
121 Interface name used by the service object to connect.
122 This name can be used for SO_BINDTODEVICE in the
127 Current IPv4 configuration.
131 Current IPv6 configuration.
133 array{string} AllowedBearers [readwrite]
135 A list of bearers that can be used for this session.
136 In general this list should be empty to indicate that
137 any bearer is acceptable.
139 The order of the entries in AllowedBearers matters.
140 The services are sorted in the order of the bearer
141 entries in this list.
143 Also "*" matches any bearer. This is usefull to prefer
144 certain bearers such as Wifi with a fallback to any
145 other available bearer.
147 string ConnectionType [readwrite]
149 This is used to indicate which connection is requested
150 from the session. The state of the session will be
151 updated accordingly. Values can be 'local',
154 'local' means the session requests to be connected,
155 but does not require specifically to be online.
156 Therefore State property will be set to 'connected' if
157 underlying service gets ready and/or online.
159 'online' means the session requests to be connected,
160 and online. State property will never get 'connected'
161 but instead will switch to 'online' if underlying
164 'any' means either 'local' or 'internet'.
166 Invalid values will be ignored and removed. An
167 empty ConnectionType is an invalid configuration.
169 When a session is created and the provided settings
170 dictionary does not contain ConnectionType, a default
171 session with 'any' will be created.
173 (This setting will be removed when the unique process
174 identifaction problem is solved.)