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
25 array{object,dict} GetTechnologies()
27 Returns a list of tuples with technology object
28 path and dictionary of technology properties.
30 Possible Errors: [service].Error.InvalidArguments
32 array{object,dict} GetServices()
34 Returns a sorted list of tuples with service
35 object path and dictionary of service properties.
37 This list will not contain sensitive information
40 Possible Errors: [service].Error.InvalidArguments
42 object ConnectProvider(dict provider)
44 Connect to a VPN specified by the given provider
47 When successful this method will return the object
48 path of the VPN service object.
50 This method can also be used to connect to an
53 This method call will only return in case of an
54 error or when the service is fully connected. So
55 setting a longer D-Bus timeout might be a really
58 When 'SessionMode' property is enabled, this method
61 Possible Errors: [service].Error.InvalidArguments
63 void RegisterAgent(object path)
65 Register new agent for handling user requests.
67 Possible Errors: [service].Error.InvalidArguments
69 void UnregisterAgent(object path)
71 Unregister an existing agent.
73 Possible Errors: [service].Error.InvalidArguments
75 void RegisterCounter(object path, uint32 accuracy, uint32 period) [experimental]
77 Register a new counter for user notifications.
79 The accuracy is specified in kilo-bytes and defines
80 a threshold for counter updates. Together with the
81 period value it defines how often user space needs
82 to be updated. The period value is in seconds.
84 This interface is not meant for time tracking. If
85 the time needs to be tracked down to the second, it
86 is better to have a real timer running inside the
87 application than using this interface.
89 Also getting notified for every kilo-byte is a bad
90 choice (even if the interface supports it). Something
91 like 10 kilo-byte units or better 1 mega-byte seems
92 to be a lot more reasonable and better for the user.
94 Possible Errors: [service].Error.InvalidArguments
96 void UnregisterCounter(object path) [experimental]
98 Unregister an existing counter.
100 Possible Errors: [service].Error.InvalidArguments
102 object CreateSession(dict settings, object notifier) [experimental]
104 Create a new session for the application. Every
105 application can create multiple session with
106 different settings. The settings are described
107 as part of the session interface.
109 The notifier allows asynchronous notification about
110 session specific changes. These changes can be
111 for online/offline state or IP address changes or
112 similar things the application is required to
115 Every application should at least create one session
116 to inform about its requirements and it purpose.
118 void DestroySession(object session) [experimental]
120 Remove the previously created session.
122 If an application exits unexpectatly the session
123 will be automatically destroyed.
125 object path, dict, fd RequestPrivateNetwork(dict options)
128 Request a new Private Network, which includes the
129 creation of a tun/tap interface, and IP
130 configuration, NAT and IP forwarding on that
132 An object path, a dictionnary and a file descriptor
133 with IP settings are returned.
135 Possible Errors: [service].Error.InvalidArguments
136 [service].Error.NotSupported
138 void ReleasePrivateNetwork(object path) [experimental]
140 Releases a private network.
142 Possible Errors: [service].Error.InvalidArguments
144 Signals TechnologyAdded(object path, dict properties)
146 Signal that is sent when a new technology is added.
148 It contains the object path of the technology and
151 TechnologyRemoved(object path)
153 Signal that is sent when a modem has been removed.
155 The object path is no longer accessible after this
156 signal and only emitted for reference.
158 ServicesAdded(array{object, dict})
160 List of service that have been added. The array
161 is a list of services that is sorted with existing
162 services containing an empty dictionary and new
163 services containing the properties.
165 This signal will only inform about added services
166 and in case that services get added and removed at
167 the same time, a ServicesRemoved signal will be
170 ServicesRemoved(array{object})
172 Signals a list of services that are no longer valid.
174 The object paths are no longer accessible after
175 this signal and only emitted for reference.
177 PropertyChanged(string name, variant value)
179 This signal indicates a changed value of the given
182 Properties string State [readonly]
184 The global connection state of a system. Possible
185 values are "online" if at least one connection exists
186 and "offline" if no device is connected.
188 In certain situations the state might change to
189 the value "connected". This can only be seen if
190 previously no connection was present.
192 boolean OfflineMode [readwrite]
194 The offline mode indicates the global setting for
195 switching all radios on or off. Changing offline mode
196 to true results in powering down all devices. When
197 leaving offline mode the individual policy of each
198 device decides to switch the radio back on or not.
200 During offline mode, it is still possible to switch
201 certain technologies manually back on. For example
202 the limited usage of WiFi or Bluetooth devices might
203 be allowed in some situations.
205 boolean SessionMode [readwrite] [experminental]
207 This disables the auto connect feature. It should be
208 enabled when the Session API is used. When SessionMode
209 is enabled, 'ConnectService' and 'ConnectProvider'
210 method calls are disallowed.
212 The default value is false.