aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGrant Erickson <gerickson@nuovations.com>2023-12-21 14:34:24 -0800
committerMarcel Holtmann <marcel@holtmann.org>2023-12-23 13:19:19 +0100
commit3df8078c579f5d922f38baab2abed996ed2b40df (patch)
treedee59150eaf539ad23819307be4ef2177c5c845f
parent51c63bb2f807737885807c0f793cca63ea060052 (diff)
downloadconnman-3df8078c579f5d922f38baab2abed996ed2b40df.tar.gz
doc/service: Document online check failure service error.
This adds documentation for the online check failure service error enumeration and string.
-rw-r--r--doc/service-api.txt3
-rw-r--r--include/service.h7
2 files changed, 9 insertions, 1 deletions
diff --git a/doc/service-api.txt b/doc/service-api.txt
index c0d5adbb2..89208a6dc 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 bfa3ab259..f194422fa 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,
};