evs_leave(3) [debian man page]

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

NAME

       evs_leave - Leave one or more groups in the EVS library

SYNOPSIS

       #include <corosync/evs.h>

       int evs_leave(evs_handle_t handle, evs_group_t *groups, int group_entries);

DESCRIPTION

       The  evs_leave  function is used to leave one or more groups.  The joined groups are used with evs_mcast_joined(3) function to multicast to
       the groups joined in the argument handle.  Messages that are sent to any of the joined groups to the parameter handle will be delivered	by
       evs_dispatch(3).

       This call may be used more then once on a handle.

       The  argument  groups is used to specify the groups to leave.  A group is a 32 byte key.  The key is not a string, hence, the entire key is
       used when leaveing the channel.	For that reason the entire group should be initialized.

       The argument group_entries specifies how many entries are located in the groups argument.

       The groups argument is of the type evs_group_t which is defined by the structure:

	      typedef struct {
		      char key[32];
	      } evs_groups_t;

RETURN VALUE

       This call returns the EVS_OK value if successful, otherwise an error is returned.

ERRORS

       The errors are undocumented.

SEE ALSO

       evs_overview(8), evs_initialize(3), evs_finalize(3), evs_fd_get(3), evs_dispatch(3), evs_join(3), evs_mcast_joined(3), evs_mcast_groups(3),
       evs_mmembership_get(3) evs_context_get(3) evs_context_set(3)

corosync Man Page						    2004-08-31							      EVS_LEAVE(3)

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

NAME

       evs_initialize - Create a new connection to the EVS service

SYNOPSIS

       #include <corosync/evs.h>

       int evs_initialize(evs_handle_t *handle, evs_callbacks_t *callbacks);

DESCRIPTION

       The evs_initialize function is used to initialize a connection to the extended virtual synchrony API.

       Each  application may have several connections to the EVS API.  Each  application uses the handle argument to uniquely identify the connec-
       tion.  The handle argument is then used in other function calls to identify the connection to be used for communication with the  EVS  ser-
       vice.

       Every  time  an EVS event occurs, one of the callbacks specified by the argument callbacks is called.  The callback functions are described
       by the following type definitions:

	      typedef void (*evs_deliver_fn_t) (
		  unsigned int nodeid,
		      const void *msg,
		      size_t msg_len);

	      typedef void (*evs_confchg_fn_t) (
		  unsigned int *member_list, size_t member_list_entries,
		  unsigned int *left_list, size_t left_list_entries,
		  unsigned int *joined_list, size_t joined_list_entries);

       The callbacks argument is of the type:

	      typedef struct {
		      evs_deliver_fn_t evs_deliver_fn;
		      evs_confchg_fn_t evs_confchg_fn;
	      } evs_callbacks_t;

       When a configuration change occurs or a message is to be delivered one of the callbacks is called from the evs_dispatch() function.   If  a
       configuration change occurs, evs_confchg_fn is called.  If a delivery of a message occurs, evs_deliver_fn is called.

RETURN VALUE

       This call returns the EVS_OK value if successful, otherwise an error is returned.

ERRORS

       The errors are undocumented.

SEE ALSO

       evs_overview(8),  evs_finalize(3),  evs_fd_get(3),  evs_dispatch(3),  evs_join(3),  evs_leave(3), evs_mcast_joined(3), evs_mcast_groups(3),
       evs_mmembership_get(3) evs_context_get(3) evs_context_set(3)

corosync Man Page						    2004-08-31							 EVS_INITIALIZE(3)