From bfdc47eca9d322680ccda988e4a1fae57f433e48 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?=
Date: Tue, 16 Feb 2016 16:09:52 +0100
Subject: kernel: Add heart validation callback documentation
---
lib/kernel/doc/src/heart.xml | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
(limited to 'lib')
diff --git a/lib/kernel/doc/src/heart.xml b/lib/kernel/doc/src/heart.xml
index b9fad17ce1..f32b74dc24 100644
--- a/lib/kernel/doc/src/heart.xml
+++ b/lib/kernel/doc/src/heart.xml
@@ -154,6 +154,34 @@
the empty string will be returned.
+
+
+
+ Set a validation callback
+
+ This validation callback will be executed before any heartbeat sent
+ to the port program. For the validation to succeed it needs to return
+ with the value ok.
+
+ An exception within the callback will be treated as a validation failure.
+ The callback will be removed if the system reboots.
+
+
+
+
+ Clear the validation callback
+
+ Removes the validation callback call before heartbeats.
+
+
+
+
+ Get the validation callback
+
+ Get the validation callback. If the callback is cleared, none will be returned.
+
+
+
--
cgit v1.2.3