diff mbox series

[08/14] doc: document BasicServiceSet API

Message ID 20240807181427.170515-8-prestwoj@gmail.com (mailing list archive)
State New
Headers show
Series [01/14] network: add network_bss_list_prune | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
prestwoj/iwd-ci-gitlint success GitLint

Commit Message

James Prestwood Aug. 7, 2024, 6:14 p.m. UTC
---
 doc/basic-service-set.txt | 10 ++++++++++
 doc/network-api.txt       |  5 +++++
 doc/station-api.txt       |  6 ++++++
 3 files changed, 21 insertions(+)
 create mode 100644 doc/basic-service-set.txt

Comments

Denis Kenzior Aug. 8, 2024, 2:42 p.m. UTC | #1
Hi James,

On 8/7/24 1:14 PM, James Prestwood wrote:
> ---
>   doc/basic-service-set.txt | 10 ++++++++++
>   doc/network-api.txt       |  5 +++++
>   doc/station-api.txt       |  6 ++++++
>   3 files changed, 21 insertions(+)
>   create mode 100644 doc/basic-service-set.txt
> 
> diff --git a/doc/basic-service-set.txt b/doc/basic-service-set.txt
> new file mode 100644
> index 00000000..2ebb63be
> --- /dev/null
> +++ b/doc/basic-service-set.txt
> @@ -0,0 +1,10 @@
> +Basic service set hierarchy
> +=================
> +
> +Service		net.connman.iwd
> +Interface	net.connman.iwd.BasicServiceSet
> +Object path	/net/connman/iwd/{phy0,phy1,...}/{1,2,...}/Xxx
> +
> +Properties	string Bssid [readonly]

Lets call this Address to be consistent with .Device, 
.Station.GetHiddenAccessPoints, etc

> +
> +			MAC address of BSS
> diff --git a/doc/network-api.txt b/doc/network-api.txt
> index e4a34411..3aa68382 100644
> --- a/doc/network-api.txt
> +++ b/doc/network-api.txt
> @@ -50,3 +50,8 @@ Properties	string Name [readonly]
>   			corresponding to this Network.  If the network
>   			is not provisioned or has not been connected to
>   			before, the property is omitted.
> +
> +		a(o) BasicServiceSets [readonly]

Should just be ao, there's no encompassing structure.  Lets just call this 
ServiceSet maybe? Or ExtendedServiceSet if you want to use the spec terminology.

> +
> +			Contains a list of paths of each individual
> +			BasicServiceSet object.
> diff --git a/doc/station-api.txt b/doc/station-api.txt
> index 05dd137e..7b067620 100644
> --- a/doc/station-api.txt
> +++ b/doc/station-api.txt
> @@ -164,6 +164,12 @@ Properties	string State [readonly]
>   			for networks.  net.connman.iwd.Network objects are
>   			updated when this property goes from true to false.
>   
> +		object ConnectedBss [readonly, optional]

ConnectedBasicServiceSet?  We also use AccessPoint terminology in 
GetHiddenAccessPoints, so maybe ConnectedAccessPoint?  This is Station after all.

> +
> +			net.connman.iwd.BasicServiceSet object represeting the
> +			BSS the device is currently connected to or to which
> +			a connection is in progress.
> +
>   SignalLevelAgent hierarchy
>   ==========================
>   

Regards,
-Denis
diff mbox series

Patch

diff --git a/doc/basic-service-set.txt b/doc/basic-service-set.txt
new file mode 100644
index 00000000..2ebb63be
--- /dev/null
+++ b/doc/basic-service-set.txt
@@ -0,0 +1,10 @@ 
+Basic service set hierarchy
+=================
+
+Service		net.connman.iwd
+Interface	net.connman.iwd.BasicServiceSet
+Object path	/net/connman/iwd/{phy0,phy1,...}/{1,2,...}/Xxx
+
+Properties	string Bssid [readonly]
+
+			MAC address of BSS
diff --git a/doc/network-api.txt b/doc/network-api.txt
index e4a34411..3aa68382 100644
--- a/doc/network-api.txt
+++ b/doc/network-api.txt
@@ -50,3 +50,8 @@  Properties	string Name [readonly]
 			corresponding to this Network.  If the network
 			is not provisioned or has not been connected to
 			before, the property is omitted.
+
+		a(o) BasicServiceSets [readonly]
+
+			Contains a list of paths of each individual
+			BasicServiceSet object.
diff --git a/doc/station-api.txt b/doc/station-api.txt
index 05dd137e..7b067620 100644
--- a/doc/station-api.txt
+++ b/doc/station-api.txt
@@ -164,6 +164,12 @@  Properties	string State [readonly]
 			for networks.  net.connman.iwd.Network objects are
 			updated when this property goes from true to false.
 
+		object ConnectedBss [readonly, optional]
+
+			net.connman.iwd.BasicServiceSet object represeting the
+			BSS the device is currently connected to or to which
+			a connection is in progress.
+
 SignalLevelAgent hierarchy
 ==========================