Possible Errors: [service].Error.InvalidArguments
[service].Error.InvalidProperty
- void RequestScan(string type)
+ array{object,dict} GetTechnologies()
- Request to trigger a scan for the specified
- technology. The empty string "" triggers scanning
- on all technologies.
-
- Possible Errors: [service].Error.InvalidArguments
-
- void EnableTechnology(string type)
-
- Enable specified type of technologies.
-
- Possible Errors: [service].Error.InvalidArguments
-
- void DisableTechnology(string type)
-
- Disable specified type of technologies.
+ Returns a list of tuples with technology object
+ path and dictionary of technology properties.
Possible Errors: [service].Error.InvalidArguments
Possible Errors: [service].Error.InvalidArguments
- object LookupService(string pattern)
-
- Lookup a service matching the specific pattern.
-
- Examples are interface names like "eth0", "wlan0"
- etc. or service names like "hotspot" etc.
-
- In case of multiple services match the the pattern
- an error is returned.
-
- Possible Errors: [service].Error.InvalidArguments
- [service].Error.NotUnique
- [service].Error.NotFound
-
- object ConnectService(dict network)
-
- Connect to a network specified by the given
- properties.
-
- For connecting to a hidden WiFi network for example
- it is required that Type = "wifi" and the SSID
- properties are provided.
-
- When successful this method will return object
- path of the service object.
-
- This method can also be used to connect to an
- already existing service. It works exactly the
- same as executing the Connect method from the
- service interface.
-
- 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.
+ array{object,dict} GetPeers() [experimental]
- When 'SessionMode' property is enabled, this method
- call is disallowed.
+ Returns a sorted list of tuples with peer object path
+ and dictionary of peer properties
Possible Errors: [service].Error.InvalidArguments
- void ProvisionService(string configuration)
+ array{string} GetTetheringClients() [experimental]
- Provide a configuration for services.
+ Returns a sorted list of MAC addresses of clients
+ connected to tethered technologies.
- Service configuration is provided as a single string
- that follows the same format as configuration files,
- see config-format.txt. An exception to this format
- is that only one service can be provisioned per call.
-
- Possible Errors: [service].Error.InvalidArguments
-
- object ConnectProvider(dict provider)
+ object ConnectProvider(dict provider) [deprecated]
Connect to a VPN specified by the given provider
properties.
When 'SessionMode' property is enabled, this method
call is disallowed.
+ This API is deprecated and should not be used.
+ The VPN configuration API is provided by ConnMan
+ VPN daemon and user should use that one instead.
+
Possible Errors: [service].Error.InvalidArguments
+ void RemoveProvider(object path) [deprecated]
+
+ Remove a VPN specified by the object path.
+
void RegisterAgent(object path)
Register new agent for handling user requests.
Possible Errors: [service].Error.InvalidArguments
- object CreateSession(dict settings, object notifier)
+ object CreateSession(dict settings, object notifier) [experimental]
Create a new session for the application. Every
application can create multiple session with
Every application should at least create one session
to inform about its requirements and it purpose.
- void DestroySession(object session)
+ void DestroySession(object session) [experimental]
Remove the previously created session.
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
+ An object path, a dictionary and a file descriptor
with IP settings are returned.
Possible Errors: [service].Error.InvalidArguments
Possible Errors: [service].Error.InvalidArguments
-Signals PropertyChanged(string name, variant value)
+ void RegisterPeerService(dict specification, boolean master)
+ [experimental]
- This signal indicates a changed value of the given
- property.
+ Registers a local P2P Peer service
-Properties string State [readonly]
+ Even if p2p techonology is not available, it will be
+ possible to register peer services, since a p2p
+ enabled WiFi device might appear at anytime. The
+ registered peer services will automatically be enabled
+ for the p2p WiFi device; the application does not need
+ to do any re-registration.
- The global connection state of a system. Possible
- values are "online" if at least one connection exists
- and "offline" if no device is connected.
+ A Peer service belongs to the process that registers
+ it, thus if that process dies, its Peer services will
+ be destroyed as well.
+
+ The specification dict follows the format described
+ in the Peer API document.
- In certain situations the state might change to
- the value "connected". This can only be seen if
- previously no connection was present.
+ ConnMan will be able to determine in most cases
+ whether to be the P2P Group Owner or not. If the
+ service for some reason must belong to a group that
+ this device manages, the "master" property can be
+ set. Do not enable the "master" property unless it
+ is absolutely sure that this is needed for the
+ provided peer service.
- array{string} AvailableTechnologies [readonly]
+ Possible Errors: [service].Error.InvalidArguments
+ [service].Error.AlreadyExists
+ [service].Error.NotSupported
+
+ void UnregisterPeerService(dict specification) [experimental]
+
+ Unregisters an existing local P2P Peer service
+
+ Possible Errors: [service].Error.InvalidArguments
+ [service].Error.NotRegistered
+
+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 technology has been removed.
+
+ The object path is no longer accessible after this
+ signal and only emitted for reference.
+
+ ServicesChanged(array{object, dict}, array{object})
+
+ This signal indicates a change in the services.
+ List of all services currently registered is passed
+ via the first array. And a list of services that have
+ been removed via the second array.
+
+ The list of all services is sorted. The dictionary
+ with the properties might be empty in case none of
+ the properties have changed. Or only contains the
+ properties that have changed.
+
+ For newly added services the whole set of properties
+ will be present.
+
+ The list of removed services can be empty.
+
+ This signal will only be triggered when the sort
+ order of the service list or the number of services
+ changes. It will not be emitted if only a property
+ of the service object changes. For that it is
+ required to watch the PropertyChanged signal of
+ the service object.
+
+ PeersChanged(array{object, dict}, array{object}) [experimental]
- The list of available technologies. The strings
- are the same as the ones from the service types.
+ This signal indicates a change in the peers. List of
+ all peers currently registered is passed via the first
+ array. And a list of peers that have been removed via
+ the second array.
- array{string} EnabledTechnologies [readonly]
+ The list of all peers is sorted. The dictionary
+ with the properties might be empty in case none of the
+ properties have changed. Or only contains the
+ properties that have changed.
- The list of enabled technologies. The strings
- are the same as the ones from the service types.
+ For newly added peers the whole set of properties will
+ be present.
- array{string} ConnectedTechnologies [readonly]
+ The list of removed peers can be empty.
- The list of connected technologies. The strings
- are the same as the ones from the service type.
+ This signal will only be triggered when the sort order
+ of the peer list or the number of peers changes. It
+ will not be emitted if only a property of the peer
+ object changes. For that it is required to watch the
+ PropertyChanged signal of the peer object.
- string DefaultTechnology [readonly]
+ TetheringClientsChanged(array{string}, array{string}) [experimental]
- The current connected technology which holds the
- default route.
+ This signal indicates a change in the tethering clients.
+ List of all tethering clients currently registered connman is
+ passed via the first array. And a list of tethering clients that
+ have been removed via the second array.
+
+ PropertyChanged(string name, variant value)
+
+ This signal indicates a changed value of the given
+ property.
+
+Properties string State [readonly]
+
+ The global connection state of a system. Possible
+ values are "offline", "idle", "ready" and "online".
+
+ If the device is in offline mode, the value "offline"
+ indicates this special global state. It can also be
+ retrieved via the OfflineMode property, but is kept
+ here for consistency and to differentiate from "idle".
+
+ However when OfflineMode property is true, the State
+ property can still be "idle", "ready" or "online"
+ since it is possible by the end user to re-enable
+ individual technologies like WiFi and Bluetooth while
+ in offline mode.
+
+ The states "idle", "ready" and "online" match to
+ states from the services. If no service is in
+ either "ready" or "online" state it will indicate
+ the "idle" state.
+
+ If at least one service is in "ready" state and no
+ service is in "online" state, then it will indicate
+ the "ready" state.
+
+ When at least one service is in "online" state,
+ this property will indicate "online" as well.
boolean OfflineMode [readwrite]
the limited usage of WiFi or Bluetooth devices might
be allowed in some situations.
- array{object} Technologies [readonly]
-
- List of technology 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]
+ boolean SessionMode [readwrite] [experminental][deprecated]
- 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.
+ This property exists only for compatibility reasons
+ and does not affect ConnMan in any way.
The default value is false.
projects / platform / upstream / connman.git / blobdiff