votequorum_initialize(3) Create a new connection to the VoteQuorum service

SYNOPSIS

#include <corosync/votequorum.h>

int votequorum_initialize(votequorum_handle_t *handle, votequorum_callbacks_t *callbacks);

DESCRIPTION

The votequorum_initialize function is used to initialize a connection to the vote-based quorum database API.

Each application may have several connections to the votequorum API. Each application uses the handle argument to uniquely identify the connection. The handle argument is then used in other function calls to identify the connection to be used for communication with the votequorum service.

Every time the voting configuraton changes (eg a node joins or leave the cluster), the callback is called. The callback function is described by the following type definitions:

typedef void (*votequorum_notification_fn_t) (
        votequorum_handle_t handle,
        uint64_t context,
        uint32_t quorate,
        uint32_t node_list_entries,
        votequorum_node_t node_list[]
        );

Current ring_id (one get in votequorum_notification_fn) must be passed to votequorum_qdevice_poll to make qdevice voting valid.

Every time the expected votes are changed, the callback is called. The expected votes callback function is described by the following type definitions:

typedef void (*votequorum_expectedvotes_notification_fn_t) (
        votequorum_handle_t handle,
        uint64_t context,
        uint32_t expected_votes);

The callbacks argument is of the type:

typedef struct {
        votequorum_notification_fn_t votequorum_notify_fn;
        votequorum_expectedvotes_notification_fn_t votequorum_expectedvotes_notify_fn;
} votequorum_callbacks_t;

When a configuration change occurs, the callback is called from the votequorum_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