diff options
author | Björn-Egil Dahlberg <[email protected]> | 2016-02-25 15:53:48 +0100 |
---|---|---|
committer | Björn-Egil Dahlberg <[email protected]> | 2016-02-25 16:04:33 +0100 |
commit | 8ead4dbf8a2f73325dbc3113abf2e5dd4f885bb2 (patch) | |
tree | 0b3ba7d2c7d6702e685e0fa5ef64bab0b710055d /lib/kernel/doc/src/heart.xml | |
parent | 023f096db6c225499b7af0fdea984a078bd660f9 (diff) | |
parent | 93d2038e91854d4bc4fd75dac7005719a79949cd (diff) | |
download | otp-8ead4dbf8a2f73325dbc3113abf2e5dd4f885bb2.tar.gz otp-8ead4dbf8a2f73325dbc3113abf2e5dd4f885bb2.tar.bz2 otp-8ead4dbf8a2f73325dbc3113abf2e5dd4f885bb2.zip |
Merge branch 'maint'
Conflicts:
erts/emulator/beam/erl_alloc.types
erts/emulator/beam/erl_bif_info.c
erts/emulator/beam/erl_process.c
erts/preloaded/ebin/erts_internal.beam
Diffstat (limited to 'lib/kernel/doc/src/heart.xml')
-rw-r--r-- | lib/kernel/doc/src/heart.xml | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/heart.xml b/lib/kernel/doc/src/heart.xml index b9fad17ce1..9da4773f2d 100644 --- a/lib/kernel/doc/src/heart.xml +++ b/lib/kernel/doc/src/heart.xml @@ -118,6 +118,13 @@ <p>In the following descriptions, all function fails with reason <c>badarg</c> if <c>heart</c> is not started.</p> </description> + + <datatypes> + <datatype> + <name name="heart_option"/> + </datatype> + </datatypes> + <funcs> <func> <name name="set_cmd" arity="1"/> @@ -154,6 +161,62 @@ 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> + + <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>check_schedulers</c></tag> + <item> + <p>If enabled, a signal 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 heartbeat and thus eventually 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> |