aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBjörn-Egil Dahlberg <[email protected]>2016-02-22 17:45:21 +0100
committerBjörn-Egil Dahlberg <[email protected]>2016-02-23 16:37:53 +0100
commit4603e0d2b49e7ab488698a22b7831d3f3f113166 (patch)
treebcab0eaa84822baf228a9b09b61ca7da34464567
parentf623b7430ec8f7bc48770953b32a486816ad6eb1 (diff)
downloadotp-4603e0d2b49e7ab488698a22b7831d3f3f113166.tar.gz
otp-4603e0d2b49e7ab488698a22b7831d3f3f113166.tar.bz2
otp-4603e0d2b49e7ab488698a22b7831d3f3f113166.zip
kernel: Add heart options documentation
-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 f32b74dc24..a4569b5fb8 100644
--- a/lib/kernel/doc/src/heart.xml
+++ b/lib/kernel/doc/src/heart.xml
@@ -182,6 +182,34 @@
</desc>
</func>
+ <func>
+ <name name="set_options" arity="1"/>
+ <fsummary>Set a list of options</fsummary>
+ <desc>
+ <p> Valid options <c>set_options</c> are: </p>
+ <taglist>
+ <tag><c>scheduler</c></tag>
+ <item>
+ <p>If enabled, a message will be sent to each scheduler to check its
+ responsiveness. The system check occurs before any heartbeat sent
+ to the port program. If any scheduler is not responsive enough the
+ heart program will not receive its heartpeat and terminate the node.
+ </p>
+ </item>
+ </taglist>
+ <p> Returns with the value <c>ok</c> if the options are valid.</p>
+ </desc>
+ </func>
+ <func>
+ <name name="get_options" arity="0"/>
+ <fsummary>Get the temporary reboot command</fsummary>
+ <desc>
+ <p>Returns <c>{ok, Options}</c> where <c>Options</c> is a list of current options enabled for heart.
+ If the callback is cleared, <c>none</c> will be returned.</p>
+ </desc>
+ </func>
+
+
</funcs>
</erlref>