Manager hierarchy
=================
-Service org.moblin.connman
-Interface org.moblin.connman.Manager
+Service net.connman
+Interface net.connman.Manager
Object path /
Methods dict GetProperties()
Possible Errors: [service].Error.InvalidArguments
[service].Error.InvalidProperty
- object AddProfile(string name)
+ array{object,dict} GetTechnologies()
- Add a new profile with the specified name.
-
- It is possible to create two profiles with the same
- name. The identification is done via the object path
- and not the name of the profile.
+ Returns a list of tuples with technology object
+ path and dictionary of technology properties.
Possible Errors: [service].Error.InvalidArguments
- void RemoveProfile(object path)
-
- Remove profile with specified object path.
+ array{object,dict} GetServices()
- It is not possible to remove the current active
- profile. To remove the active profile a different
- one must be selected via ActiveProfile property
- first.
+ Returns a sorted list of tuples with service
+ object path and dictionary of service properties.
- At minimum one profile must be available all the time.
+ This list will not contain sensitive information
+ like passphrases etc.
Possible Errors: [service].Error.InvalidArguments
- void RequestScan(string type)
+ object ConnectProvider(dict provider)
+
+ Connect to a VPN specified by the given provider
+ properties.
+
+ When successful this method will return the object
+ path of the VPN service object.
- Request to trigger a scan for the specified
- technology. The empty string "" triggers scanning
- on all technologies.
+ This method can also be used to connect to an
+ already existing VPN.
+
+ This method call will only return in case of an
+ error or when the service is fully connected. So
+ setting a longer D-Bus timeout might be a really
+ good idea.
+
+ When 'SessionMode' property is enabled, this method
+ call is disallowed.
Possible Errors: [service].Error.InvalidArguments
Possible Errors: [service].Error.InvalidArguments
-Signals PropertyChanged(string name, variant value)
+ void RegisterCounter(object path, uint32 accuracy, uint32 period) [experimental]
- This signal indicates a changed value of the given
- property.
+ Register a new counter for user notifications.
+
+ The accuracy is specified in kilo-bytes and defines
+ a threshold for counter updates. Together with the
+ period value it defines how often user space needs
+ to be updated. The period value is in seconds.
+
+ This interface is not meant for time tracking. If
+ the time needs to be tracked down to the second, it
+ is better to have a real timer running inside the
+ application than using this interface.
+
+ Also getting notified for every kilo-byte is a bad
+ choice (even if the interface supports it). Something
+ like 10 kilo-byte units or better 1 mega-byte seems
+ to be a lot more reasonable and better for the user.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+ void UnregisterCounter(object path) [experimental]
+
+ Unregister an existing counter.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+ object CreateSession(dict settings, object notifier) [experimental]
+
+ Create a new session for the application. Every
+ application can create multiple session with
+ different settings. The settings are described
+ as part of the session interface.
+
+ The notifier allows asynchronous notification about
+ session specific changes. These changes can be
+ for online/offline state or IP address changes or
+ similar things the application is required to
+ handle.
+
+ Every application should at least create one session
+ to inform about its requirements and it purpose.
+
+ void DestroySession(object session) [experimental]
+
+ Remove the previously created session.
+
+ If an application exits unexpectatly the session
+ will be automatically destroyed.
+
+ object path, dict, fd RequestPrivateNetwork(dict options)
+ [experimental]
+
+ Request a new Private Network, which includes the
+ creation of a tun/tap interface, and IP
+ configuration, NAT and IP forwarding on that
+ interface.
+ An object path, a dictionnary and a file descriptor
+ with IP settings are returned.
+
+ Possible Errors: [service].Error.InvalidArguments
+ [service].Error.NotSupported
+
+ void ReleasePrivateNetwork(object path) [experimental]
+
+ Releases a private network.
+
+ Possible Errors: [service].Error.InvalidArguments
+
+Signals TechnologyAdded(object path, dict properties)
+
+ Signal that is sent when a new technology is added.
+
+ It contains the object path of the technology and
+ also its properties.
+
+ TechnologyRemoved(object path)
+
+ Signal that is sent when a modem has been removed.
+
+ The object path is no longer accessible after this
+ signal and only emitted for reference.
+
+ ServicesAdded(array{object, dict})
+
+ List of service that have been added. The array
+ is a list of services that is sorted with existing
+ services containing an empty dictionary and new
+ services containing the properties.
+
+ This signal will only inform about added services
+ and in case that services get added and removed at
+ the same time, a ServicesRemoved signal will be
+ sent first.
- StateChanged(string state)
+ ServicesRemoved(array{object})
- This signal is similar to the PropertyChanged signal
- for the State property.
+ Signals a list of services that are no longer valid.
- It exists for application state only care about the
- current state and so can avoid to be woken up when
- other details changes.
+ The object paths are no longer accessible after
+ this signal and only emitted for reference.
+
+ PropertyChanged(string name, variant value)
+
+ This signal indicates a changed value of the given
+ property.
Properties string State [readonly]
the limited usage of WiFi or Bluetooth devices might
be allowed in some situations.
- object ActiveProfile [readwrite]
-
- Object path of the current active profile.
-
- array{object} Profiles [readonly]
-
- List of profile object paths.
-
- array{object} Devices [readonly]
-
- List of device object paths.
-
- array{object} Services [readonly]
-
- List of service object paths. The list is sorted
- internally to have the service with the default
- route always first and then the favorite services
- followed by scan results.
-
- This list represents the available services for the
- current selected profile. If the profile gets changed
- then this list will be updated.
-
- The same list is available via the profile object
- itself. It is just provided here for convenience of
- applications only dealing with the current active
- profile.
+ boolean SessionMode [readwrite] [experminental]
- array{object} Connections [readonly]
+ This disables the auto connect feature. It should be
+ enabled when the Session API is used. When SessionMode
+ is enabled, 'ConnectService' and 'ConnectProvider'
+ method calls are disallowed.
- List of active connection object paths.
+ The default value is false.
projects / framework / connectivity / connman.git / blobdiff