Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sam_initialize(3) [centos man page]

SAM_INITIALIZE(3)				    Corosync Cluster Engine Programmer's Manual 				 SAM_INITIALIZE(3)

NAME
sam_initialize - Initialize health checking SYNOPSIS
#include <corosync/sam.h> cs_error_t sam_initialize (int time_interval, sam_recovery_policy_t recovery_policy); DESCRIPTION
The sam_initialize function is used to initialize health checking of a process. Application can have only one instance of SAM. This function must be called before any other of SAM functions. It is recommended to ini- tialize before the process begins any process initialization. The time_interval parameter is a timeout in milliseconds before taking recovery action after having not received a healthcheck. If time_interval parameter is zero, there is no time limit and no healthcheck must be sent by the process. In this operational mode, a process failure will continue to execute the recovery policy. The recovery_policy is defined as type: typedef enum { SAM_RECOVERY_POLICY_QUIT = 1, SAM_RECOVERY_POLICY_RESTART = 2, SAM_RECOVERY_POLICY_QUORUM = 0x08, SAM_RECOVERY_POLICY_QUORUM_QUIT = SAM_RECOVERY_POLICY_QUORUM | SAM_RECOVERY_POLICY_QUIT, SAM_RECOVERY_POLICY_QUORUM_RESTART = SAM_RECOVERY_POLICY_QUORUM | SAM_RECOVERY_POLICY_RESTART, SAM_RECOVERY_POLICY_CMAP = 0x10, SAM_RECOVERY_POLICY_CONFDB = 0x10, } sam_recovery_policy_t; where SAM_RECOVERY_POLICY_QUIT on failure, the process will terminate. SAM_RECOVERY_POLICY_RESTART on failure, the process will restart. SAM_RECOVERY_POLICY_QUORUM is not policy. Used only as flag meaning quorum integration SAM_RECOVERY_POLICY_QUORUM_QUIT same as SAM_RECOVERY_POLICY_QUIT but sam_start (3) will block until corosync becomes quorate and process will be terminated if quo- rum is lost. SAM_RECOVERY_POLICY_QUORUM_RESTART same as SAM_RECOVERY_POLICY_RESTART but sam_start (3) will block until corosync becomes quorate and process will be restarted if quorum is lost. SAM_RECOVERY_POLICY_CMAP is not policy. Used only as flag meaning cmap integration. It can be used with all previous policies. For backward compatibility, SAM_RECOVERY_POLICY_CONFDB with same meaning as SAM_RECOVERY_POLICY_CMAP is also provided. To perform event driven healthchecking, sam_register(3) and sam_start(3) functions must called. Event driven healthchecking causes the duplicate standby process running the SAM serve rto periodically request healthchecks from the active process. RETURN VALUE
This call return CS_OK value if successful, otherwise and error is returned. ERRORS
CS_ERR_BAD_HANDLE can happened in case of double initialization. CS_ERR_INVALID_PARAM recovery_policy has invalid value. SEE ALSO
sam_register(3), sam_start(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 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 corosync Man Page 21/05/2010 SAM_INITIALIZE(3)

Check Out this Related Man Page

QUORUM_INITIALIZE(3)				    Corosync Cluster Engine Programmer's Manual 			      QUORUM_INITIALIZE(3)

NAME
quorum_initialize - Create a new connection to the Quorum service SYNOPSIS
#include <corosync/quorum.h> int quorum_initialize(quorum_handle_t *handle, quorum_callbacks_t *callbacks, uint32_t *quorum_type); DESCRIPTION
The quorum_initialize function is used to initialize a connection to the quorum API. Each application may have several connections to the quorum API. Each application uses the handle argument to uniquely identify the con- nection. The handle argument is then used in other function calls to identify the connection to be used for communication with the quorum service. Every time the voting configuraton changes (eg a node joins or leave the cluster) or the quorum status change, the callback is called. The callback function is described by the following type definitions: typedef void (*quorum_notification_fn_t) ( quorum_handle_t handle, uint32_t quorate, uint64_t ring_seq, uint32_t view_list_entries, uint32_t *view_list ); The callbacks argument is of the type: typedef struct { quorum_notification_fn_t quorum_notify_fn; } quorum_callbacks_t; The quorum_type argument is set to: #define QUORUM_FREE 0 #define QUORUM_SET 1 QUORUM_FREE value means that no quorum algorithm is loaded and that no callbacks will take place. QUORUM_SET value means that one quorum algorithm is configured and that callbacks will take place. When a configuration change occurs, the callback is called from the quorum_dispatch() function. RETURN VALUE
This call returns the CS_OK value if successful, otherwise an error is returned. ERRORS
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 SEE ALSO
quorum_overview(8), quorum_finalize(3), quorum_getquorate(3), quorum_trackstart(3), quorum_trackstop(3), quorum_fd_get(3), quorum_dis- patch(3), quorum_context_set(3), quorum_context_get(3) corosync Man Page 2014-06-10 QUORUM_INITIALIZE(3)
Man Page

Featured Tech Videos