3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-12-23 06:02:37 +01:00
iwd/doc/network-api.txt
2019-10-28 21:23:05 -05:00

53 lines
1.4 KiB
Plaintext

Network hierarchy
=================
Service net.connman.iwd
Interface net.connman.iwd.Network
Object path /net/connman/iwd/{phy0,phy1,...}/{1,2,...}/Xxx
Methods void Connect()
Connect to the network. Request the device
implied by the object path to connect to specified
network.
Possible errors: net.connman.iwd.Aborted
net.connman.iwd.Busy
net.connman.iwd.Failed
net.connman.iwd.NoAgent
net.connman.iwd.NotSupported
net.connman.iwd.Timeout
net.connman.iwd.InProgress
net.connman.iwd.NotConfigured
Properties string Name [readonly]
Network SSID
boolean Connected [readonly]
Reflects whether the network is currently connected
or actively being connected to. This is meant for
the application to show a check-box or some other
means to notify the user which network is currently
selected. Refer to net.connman.iwd.Station
documentation for more details if you need to know
the actual state of the connection (i.e connecting,
connected, etc)
object Device [readonly]
The object path of the station the network belongs to.
string Type [readonly]
Contains the type of the network. Possible
types are "open", "psk", "8021x" (EAP)
object KnownNetwork [readonly, optional]
Contains the path of the KnownNetwork object
corresponding to this Network. If the network
is not provisioned or has not been connected to
before, the property is ommitted.