1SAM_START(3)      Corosync Cluster Engine Programmer's Manual     SAM_START(3)
2
3
4

NAME

6       sam_start - Start health checking
7
8

SYNOPSIS

10       #include <corosync/sam.h>
11
12
13       cs_error_t sam_start (void);
14
15

DESCRIPTION

17       The sam_start function is used to start health checking of application.
18       After  calling  this  function,  the  active  process  needs  to   send
19       healthchecks   within   the   registered   time   interval  by  calling
20       sam_hc_send(3).  If event driven healthchecking is configured by  call‐
21       ing sam_register(3), an internal thread will be created and send health
22       check confirmations four times per time_interval.
23
24
25       Application must be registered by calling sam_register(3)  before  this
26       function can be called.
27
28
29       An   application  can  always  stop  health  checking  by  calling  the
30       sam_stop(3) function.
31
32

RETURN VALUE

34       This call return CS_OK value if  successful,  otherwise  and  error  is
35       returned.
36
37

ERRORS

39       CS_ERR_BAD_HANDLE
40              component  was  not  registered by calling sam_register(3) func‐
41              tion.
42
43

SEE ALSO

45       sam_hc_send(3),  sam_stop(3),  sam_register(3),  sam_hc_callback_regis‐
46       ter(3)
47
48
49
50corosync Man Page                 12/01/2009                      SAM_START(3)
Impressum