diff options
| author | James Prestwood <prestwoj@gmail.com> | 2023-11-08 09:21:49 -0800 |
|---|---|---|
| committer | Denis Kenzior <denkenz@gmail.com> | 2023-11-09 10:21:14 -0600 |
| commit | 9dbfac275616c3a0089cf1b1f3f4f4bdf3c5947e (patch) | |
| tree | 961234530b2c8b701caf7c28ec11864d012ad668 | |
| parent | c193d3649970c336d13d6a860b1ae342182a457c (diff) | |
doc: document Stop() correctly for both DPP interfaces
Stop() was separated more clearly between the two interfaces and will
now return NotFound if called on an interface that isn't currently
running.
| -rw-r--r-- | doc/device-provisioning-api.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/device-provisioning-api.txt b/doc/device-provisioning-api.txt index 2a34d4ae2..9994aef51 100644 --- a/doc/device-provisioning-api.txt +++ b/doc/device-provisioning-api.txt @@ -18,11 +18,9 @@ Methods string StartEnrollee() void Stop() - Stop an enrollee. + Stop an enrollee or configurator that is running. - Possible errors: net.connman.iwd.Busy - net.connman.iwd.Failed - net.connman.iwd.InvalidArguments + Possible errors: net.connman.iwd.NotFound string StartConfigurator() @@ -168,6 +166,8 @@ Object path /net/connman/iwd/{phy0,phy1,...}/{1,2,...} Calling Stop() if DPP was started via the DeviceProvisioning interface will not stop it. + Possible errors: net.connman.iwd.NotFound + Properties boolean Started [readonly] True if shared code device provisioning is currently |