[PATCH v2 6/6] doc: add note about timeouts to Network.Connect()

James Prestwood
2025-05-28T20:10:37Z

Since netconfig is now part of the Connect() call from a DBus
perspective add a note indicating that this method has the potential
to take a very long time if there are issues with DHCP.
---
doc/network-api.txt | 6 ++++++
1 file changed, 6 insertions(+)

diff --git a/doc/network-api.txt b/doc/network-api.txt
index 8bc6eea6..d96fcede 100644
--- a/doc/network-api.txt
+++ b/doc/network-api.txt
@@ -11,6 +11,12 @@ Methods void Connect()
the object path to connect to specified network.
Connecting to WEP networks is not supported.

+ Note: When [General].EnableNetworkConfiguration is set
+ to true a call to Connect() has the potential to take
+ a significant amount of time. Specifically if DHCP is
+ either slow, or is unable to complete. The timeout for
+ DHCP is roughly 30 seconds per BSS.
+
Possible errors: net.connman.iwd.Aborted
net.connman.iwd.Busy
net.connman.iwd.Failed
--
2.34.1