Kernel
/
iwd
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git
3
0
Fork 0
Code Releases Activity

doc: extra clarifications for properties

This commit is contained in:
Denis Kenzior 2019-10-28 21:23:05 -05:00
parent a9c1a428b5
commit 081f595c2a
2 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/network-api.txt
View File

@ -26,12 +26,18 @@ Properties string Name [readonly]
boolean Connected [readonly]
Reflects whether the device is connected to this
network.
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 device the network belongs to.
The object path of the station the network belongs to.
string Type [readonly]

14
doc/station-api.txt
View File

@ -147,11 +147,21 @@ Properties string State [readonly]
net.connman.iwd.Network object representing the
network the device is currently connected to or to
which a connection is in progress.
which a connection is in progress. This property
will be updated with the object path of the Network
object as soon as the connection process is initiated,
and will remain for as long as the connection is in
progress, completed and the network has not been
disconnected.
On disconnection this property becomes invalid and
disappears from the property list. Refer to the
State property documentation if you need to track
the actual state of the connection.
boolean Scanning [readonly]
Reflects whether the device is currently scanning
Reflects whether the station is currently scanning
for networks. net.connman.iwd.Network objects are
updated when this property goes from true to false.