summaryrefslogtreecommitdiff
path: root/doc/session-api.txt
blob: 98051a6e52f73ef10cab5281a04d9a0885acb858 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
Service		unique name
Interface	net.connman.Notification
Object path	freely definable

Methods		void Release()

			This method gets called when the service daemon
			unregisters the session. A counter can use it to do
			cleanup tasks. There is no need to unregister the
			session, because when this method gets called it has
			already been unregistered.

		void Update(dict settings)

			Sends an update of changed settings. Only settings
			that are changed will be included.

			Initially on every session creation this method is
			called once to inform about the current settings.


Service		net.connman
Interface	net.connman.Session
Object path	variable

Methods		void Destroy()

			Close the current session. This is similar to
			DestroySession method on the manager interface. It
			is just provided for convenience depending on how
			the application wants to track the session.

		void Connect()

			If not connected, then attempt to connect this
			session.

			The usage of this method depends a little bit on
			the model of the application. Some application
			should not try to call Connect on any session at
			all. They should just monitor if it becomes online
			or gets back offline.

			Others might require an active connection right now.
			So for example email notification should only check
			for new emails when a connection is available. However
			if the user presses the button for get email or wants
			to send an email it should request to get online with
			this method.

			Depending on the bearer settings the current service
			is used or a new service will be connected.

			This method returns immediately after it has been
			called. The application is informed through the update
			notification about the state of the session.

			It is also not guaranteed that a session stays online
			after this method call. It can be taken offline at any
			time. This might happen because of idle timeouts or
			other reasons.

			It is safe to call this method multiple times. The
			actual usage will be sorted out for the application.

		void Disconnect()

			This method indicates that the current session does
			not need a connection anymore.

			This method returns immediately. The application is
			informed through the update notification about the
			state of the session.

		void Change(string name, variant value)

			Change the value of certain settings. Not all
			settings can be changed. Normally this should not
			be needed or an extra session should be created.
			However in some cases it makes sense to change
			a value and trigger different behavior.

			A change of a setting will cause an update notification
			to be sent. Some changes might cause the session to
			be moved to offline state.

Settings	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.

		string Name [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.

		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.
			In general this list should be empty to indicate that
			any bearer is acceptable.

			The order of the entries in AllowedBearers matters.
			The services are sorted in the order of the bearer
			entries in this list.

			Also "*" matches any bearer. This is usefull to prefer
			certain bearers such as Wifi with a fallback to any
			other available bearer.

		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.)