aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc/src/heart.xml
diff options
context:
space:
mode:
authorBjörn-Egil Dahlberg <[email protected]>2016-02-16 16:09:52 +0100
committerBjörn-Egil Dahlberg <[email protected]>2016-02-23 15:37:02 +0100
commitbfdc47eca9d322680ccda988e4a1fae57f433e48 (patch)
tree97fc4fbdda500c3ae5a3b35a7430fa0395f2495c /lib/kernel/doc/src/heart.xml
parenta3ed00b212fedb7dbe9dc5daf4c3beaf2c4dbe9d (diff)
downloadotp-bfdc47eca9d322680ccda988e4a1fae57f433e48.tar.gz
otp-bfdc47eca9d322680ccda988e4a1fae57f433e48.tar.bz2
otp-bfdc47eca9d322680ccda988e4a1fae57f433e48.zip
kernel: Add heart validation callback documentation
Diffstat (limited to 'lib/kernel/doc/src/heart.xml')
-rw-r--r--lib/kernel/doc/src/heart.xml28
1 files changed, 28 insertions, 0 deletions
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.</p>
</desc>
</func>
+
+ <func>
+ <name name="set_callback" arity="2"/>
+ <fsummary>Set a validation callback</fsummary>
+ <desc>
+ <p> 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 <c>ok</c>.
+ </p>
+ <p> An exception within the callback will be treated as a validation failure. </p>
+ <p> The callback will be removed if the system reboots. </p>
+ </desc>
+ </func>
+ <func>
+ <name name="clear_callback" arity="0"/>
+ <fsummary>Clear the validation callback</fsummary>
+ <desc>
+ <p>Removes the validation callback call before heartbeats.</p>
+ </desc>
+ </func>
+ <func>
+ <name name="get_callback" arity="0"/>
+ <fsummary>Get the validation callback</fsummary>
+ <desc>
+ <p>Get the validation callback. If the callback is cleared, <c>none</c> will be returned.</p>
+ </desc>
+ </func>
+
</funcs>
</erlref>