sam_hc_send man page

sam_hc_send — Send health check confirmation

Synopsis

#include <corosync/sam.h>

cs_error_t sam_hc_send (void);

Description

The sam_hc_send function is used to send healthcheck confirmation from the application.  This function should be called regularly when configured for application driven healthchecking, otherwise recovery action will be taken.

When using event driven healthchecking, this function should not be used.

Return Value

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

Errors

CS_ERR_BAD_HANDLE

health checking is not in running state (sam_start(3) has not been executed) or function is called after stop/finalization of SAM.

See Also

sam_start(3), sam_stop(3), sam_hc_callback_register(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 interrupted by a signal

CS_ERR_NOT_SUPPORTED The requested protocol/functionality not supported

CS_ERR_MESSAGE_ERROR Incorrect auth message received

CS_ERR_NO_MEMORY Not enough memory to complete the requested task

Referenced By

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

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