sam_stop man page

sam_stop — Stop health checking

Synopsis

#include <corosync/sam.h>

cs_error_t sam_stop (void);

Description

The sam_stop function is used to stop health checking of an active process. After calling this function, the application no longer should send helathchecks. In the case of event driven healthchecking, the healthchecking thread will be stopped.

A process can always start health checking again by calling sam_start(3) function.

Return Value

This call return CS_OK value if successful, otherwise and error is returned.

Errors

CS_ERR_BAD_HANDLE
health checking was not started by calling sam_start(3) function.

See Also

sam_start(3)

CS_ERR_TRY_AGAIN Resource temporarily unavailable

CS_ERR_INVALID_PARAM Invalid argument

CS_ERR_ACCESS Permission denied

CS_ERR_LIBRARY The connection failed

CS_ERR_INTERRUPT System call inturrupted by a signal

CS_ERR_NOT_SUPPORTED The requested protocol/functuality not supported

CS_ERR_MESSAGE_ERROR Incorrect auth message received

CS_ERR_NO_MEMORY Not enough memory to completed the requested task

Referenced By

sam_hc_callback_register(3), sam_hc_send(3), sam_overview(8), sam_start(3).

12/01/2009 corosync Man Page Corosync Cluster Engine Programmer's Manual