sam_finalize man page

sam_finalize — Terminate SAM service

Synopsis

#include <corosync/sam.h>

cs_error_t sam_finalize (void);

Description

The sam_finalize function is used to terminate SAM API. Once the connection is finalized, the SAM may not be used again by application. Whole functionality (health checking) will be stopped and after application fail, recovery action will not be taken.

Return Value

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

Errors

CS_ERR_BAD_HANDLE
library was not initialized by sam_init(3) function or was finished already.

See Also

sam_initialize(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_overview(8).

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