[v2,17/60] doc/service: Document online check failure service error.

Commit Message

Grant Erickson Dec. 21, 2023, 6:39 a.m. UTC

This adds documentation for the online check failure service error
enumeration and string.
---
 doc/service-api.txt | 3 ++-
 include/service.h   | 7 +++++++
 2 files changed, 9 insertions(+), 1 deletion(-)

Patch

diff --git a/doc/service-api.txt b/doc/service-api.txt
index c0d5adbb2b57..89208a6dc55f 100644
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -157,7 +157,8 @@  Properties	string State [readonly]
 
 			Currently defined error codes are: "out-of-range",
 			"pin-missing", "dhcp-failed", "connect-failed",
-			"login-failed", "auth-failed" and "invalid-key".
+			"login-failed", "auth-failed", "invalid-key",
+			"blocked", and "online-check-failed".
 
 		string Name [readonly]
 
diff --git a/include/service.h b/include/service.h
index bfa3ab2592e4..f194422fae48 100644
--- a/include/service.h
+++ b/include/service.h
@@ -80,6 +80,13 @@  enum connman_service_error {
 	CONNMAN_SERVICE_ERROR_AUTH_FAILED         = 6,
 	CONNMAN_SERVICE_ERROR_INVALID_KEY         = 7,
 	CONNMAN_SERVICE_ERROR_BLOCKED             = 8,
+
+	/**
+	 *	In "continuous" online check mode,
+	 *	the back-to-back online check
+	 *	failures threshold was met or
+	 *	exceeded.
+	 */
 	CONNMAN_SERVICE_ERROR_ONLINE_CHECK_FAILED = 9,
 };