5 Interface net.connman.Manager
8 Methods dict GetProperties()
10 Returns all global system properties. See the
11 properties section for available properties.
13 Possible Errors: [service].Error.InvalidArguments
15 void SetProperty(string name, variant value)
17 Changes the value of the specified property. Only
18 properties that are listed as read-write are
19 changeable. On success a PropertyChanged signal
22 Possible Errors: [service].Error.InvalidArguments
23 [service].Error.InvalidProperty
27 Return global connection state of a system. The
28 same value is return via the State property.
30 Possible Errors: [service].Error.InvalidArguments
32 void RequestScan(string type)
34 Request to trigger a scan for the specified
35 technology. The empty string "" triggers scanning
38 Possible Errors: [service].Error.InvalidArguments
40 void EnableTechnology(string type)
42 Enable specified type of technologies.
44 Possible Errors: [service].Error.InvalidArguments
46 void DisableTechnology(string type)
48 Disable specified type of technologies.
50 Possible Errors: [service].Error.InvalidArguments
52 array{object,dict} GetServices()
54 Returns a sorted list of tuples with service
55 object path and dictionary of service properties.
57 This list will not contain sensitive information
60 Possible Errors: [service].Error.InvalidArguments
62 object LookupService(string pattern)
64 Lookup a service matching the specific pattern.
66 Examples are interface names like "eth0", "wlan0"
67 etc. or service names like "hotspot" etc.
69 In case of multiple services match the the pattern
72 Possible Errors: [service].Error.InvalidArguments
73 [service].Error.NotUnique
74 [service].Error.NotFound
76 object ConnectService(dict network)
78 Connect to a network specified by the given
81 For connecting to a hidden WiFi network for example
82 it is required that Type = "wifi" and the SSID
83 properties are provided.
85 When successful this method will return object
86 path of the service object.
88 This method can also be used to connect to an
89 already existing service. It works exactly the
90 same as executing the Connect method from the
93 This method call will only return in case of an
94 error or when the service is fully connected. So
95 setting a longer D-Bus timeout might be a really
98 When 'SessionMode' property is enabled, this method
101 Possible Errors: [service].Error.InvalidArguments
103 void ProvisionService(string configuration)
105 Provide a configuration for services.
107 Service configuration is provided as a single string
108 that follows the same format as configuration files,
109 see config-format.txt. An exception to this format
110 is that only one service can be provisioned per call.
112 Possible Errors: [service].Error.InvalidArguments
114 object ConnectProvider(dict provider)
116 Connect to a VPN specified by the given provider
119 When successful this method will return the object
120 path of the VPN service object.
122 This method can also be used to connect to an
123 already existing VPN.
125 This method call will only return in case of an
126 error or when the service is fully connected. So
127 setting a longer D-Bus timeout might be a really
130 When 'SessionMode' property is enabled, this method
133 Possible Errors: [service].Error.InvalidArguments
135 void RegisterAgent(object path)
137 Register new agent for handling user requests.
139 Possible Errors: [service].Error.InvalidArguments
141 void UnregisterAgent(object path)
143 Unregister an existing agent.
145 Possible Errors: [service].Error.InvalidArguments
147 void RegisterCounter(object path, uint32 accuracy, uint32 period)
149 Register a new counter for user notifications.
151 The accuracy is specified in kilo-bytes and defines
152 a threshold for counter updates. Together with the
153 period value it defines how often user space needs
154 to be updated. The period value is in seconds.
156 This interface is not meant for time tracking. If
157 the time needs to be tracked down to the second, it
158 is better to have a real timer running inside the
159 application than using this interface.
161 Also getting notified for every kilo-byte is a bad
162 choice (even if the interface supports it). Something
163 like 10 kilo-byte units or better 1 mega-byte seems
164 to be a lot more reasonable and better for the user.
166 Possible Errors: [service].Error.InvalidArguments
168 void UnregisterCounter(object path)
170 Unregister an existing counter.
172 Possible Errors: [service].Error.InvalidArguments
174 object CreateSession(dict settings, object notifier)
176 Create a new session for the application. Every
177 application can create multiple session with
178 different settings. The settings are described
179 as part of the session interface.
181 The notifier allows asynchronous notification about
182 session specific changes. These changes can be
183 for online/offline state or IP address changes or
184 similar things the application is required to
187 Every application should at least create one session
188 to inform about its requirements and it purpose.
190 void DestroySession(object session)
192 Remove the previously created session.
194 If an application exits unexpectatly the session
195 will be automatically destroyed.
197 object path, dict, fd RequestPrivateNetwork(dict options)
200 Request a new Private Network, which includes the
201 creation of a tun/tap interface, and IP
202 configuration, NAT and IP forwarding on that
204 An object path, a dictionnary and a file descriptor
205 with IP settings are returned.
207 Possible Errors: [service].Error.InvalidArguments
208 [service].Error.NotSupported
210 void ReleasePrivateNetwork(object path) [experimental]
212 Releases a private network.
214 Possible Errors: [service].Error.InvalidArguments
216 Signals PropertyChanged(string name, variant value)
218 This signal indicates a changed value of the given
221 StateChanged(string state)
223 This signal is similar to the PropertyChanged signal
224 for the State property.
226 It exists for application state only care about the
227 current state and so can avoid to be woken up when
228 other details changes.
230 Properties string State [readonly]
232 The global connection state of a system. Possible
233 values are "online" if at least one connection exists
234 and "offline" if no device is connected.
236 In certain situations the state might change to
237 the value "connected". This can only be seen if
238 previously no connection was present.
240 array{string} AvailableTechnologies [readonly]
242 The list of available technologies. The strings
243 are the same as the ones from the service types.
245 array{string} EnabledTechnologies [readonly]
247 The list of enabled technologies. The strings
248 are the same as the ones from the service types.
250 array{string} ConnectedTechnologies [readonly]
252 The list of connected technologies. The strings
253 are the same as the ones from the service type.
255 string DefaultTechnology [readonly]
257 The current connected technology which holds the
260 boolean OfflineMode [readwrite]
262 The offline mode indicates the global setting for
263 switching all radios on or off. Changing offline mode
264 to true results in powering down all devices. When
265 leaving offline mode the individual policy of each
266 device decides to switch the radio back on or not.
268 During offline mode, it is still possible to switch
269 certain technologies manually back on. For example
270 the limited usage of WiFi or Bluetooth devices might
271 be allowed in some situations.
273 object ActiveProfile [readwrite]
275 Object path of the current active profile.
277 array{object} Technologies [readonly]
279 List of technology object paths.
281 array{object} Services [readonly]
283 List of service object paths. The list is sorted
284 internally to have the service with the default
285 route always first and then the favorite services
286 followed by scan results.
288 This list represents the available services for the
289 current selected profile. If the profile gets changed
290 then this list will be updated.
292 The same list is available via the profile object
293 itself. It is just provided here for convenience of
294 applications only dealing with the current active
297 boolean SessionMode [readwrite]
299 This disables the auto connect feature. It should be
300 enabled when the Session API is used. When SessionMode
301 is enabled, 'ConnectService' and 'ConnectProvider'
302 method calls are disallowed.
304 The default value is false.