sam_start(3)

sam_start3

Start health checking

Usage

#include <corosync/sam.h>

cs_error_t sam_start (void);

Overview

The sam_start function is used to start health checking of application. After calling this function, the active process needs to send healthchecks within the registered time interval by calling sam_hc_send(3). If event driven healthchecking is configured by calling sam_register(3), an internal thread will be created and send health check confirmations four times per time_interval.

Application must be registered by calling sam_register(3) before this function can be called.

An application can always stop health checking by calling the sam_stop(3) function.

If SAM is initialized with quorum policy SAM_RECOVERY_POLICY_QUIT or SAM_RECOVERY_POLICY_RESTART sam_start will block until corosync becomes quorate.

Return value

This call return CS_OK value if successful, otherwise and error is returned. If SAM is initialized with quorum policy, returned error can also be quorum error.

Errors

CS_ERR_BAD_HANDLE

component was not registered by calling sam_register(3) function.

Releases

8 releases since Debian 6.0 (Squeeze); the text changed 2 times.

  1. 6.0–8
  2. 9
  3. 10–13

From libsam-dev 3.1.9-2+deb13u1 in Debian 13 (Trixie). Parsed by carta from the page's man source.