cpg_join(3) [centos man page]

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

NAME

       cpg_join - Joins one or more groups in the CPG library

SYNOPSIS

       #include <corosync/cpg.h>

       int cpg_join(cpg_handle_t handle, struct cpg_name *group);

DESCRIPTION

       The  cpg_join function is used to join one group.  When a group is joined, the cpg_mcast_joined(3) is called internally to multicast to the
       groups joined in the argument handle.  The process will also get notifications of other processes joining and leaving the group.   Messages
       that are sent to any of the groups joined to the parameter handle will be delivered by cpg_dispatch(3).

       This function may be only be called once for each handle. When a group has been joined the process will start to receive callbacks relating
       to messages sent from members of the group or notifications of processes joining or leaving the group.

       Note that more than one process on each node can join a CPG group  and  each  will  receive  its  own  copy  of	any  messages  sent  using
       cpg_mcast_joined() and its own confchg callback.

       The argument group is used to specify the group to join.

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

	      struct cpg_name {
		      int length;
		      char value[128];
	      };

RETURN VALUE

       This call returns the CS_OK value if successful, CS_ERR_INVALID_PARAM if the handle is already joined to a group.

ERRORS

       Not all errors are documented.

SEE ALSO

       cpg_overview(8),  cpg_initialize(3),  cpg_finalize(3),  cpg_fd_get(3),  cpg_dispatch(3),  cpg_join(3),  cpg_leave(3),  cpg_mcast_joined(3),
       cpg_membership_get(3) cpg_zcb_alloc(3) cpg_zcb_free(3) cpg_zcb_mcast_joined(3) cpg_context_get(3) cpg_context_set(3) cpg_local_get(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						    2004-08-31							       CPG_JOIN(3)

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

NAME

       cpg_iteration_initialize - Initialize iterator for members of CPG

SYNOPSIS

       #include <corosync/cpg.h>

       cs_error_t  cpg_iteration_initialize  (cpg_handle_t  handle,  cpg_iteration_type_t iteration_type, const struct cpg_name *group, cpg_itera-
       tion_handle_t *cpg_iteration_handle);

DESCRIPTION

       The cpg_iteration_initialize function is used to initialize iteration of CPG members.  The handle argument is connection  to  CPG  database
       obtained by calling cpg_initialize(3) function.	iteration_type is used for limit number of returned items and can be one of:

       CPG_ITERATION_NAME_ONLY - only name of used groups are returned

       CPG_ITERATION_ONE_GROUP - only members group with name group are returned

       CPG_ITERATION_ALL - all members are returned

       The  group  parameter  is  used only with CPG_ITERATION_ONE_GROUP and it's name of group with members to iterate. For other iteration_type,
       this parameter must be NULL.

       cpg_iteration_initialize is used only for initialize context for future cpg_iteration_next(3) calls and handle needed for that function	is
       returned  in  cpg_iteration_handle variable. When you have finished iteration over objects, call cpg_iteration_finalize(3) function to free
       up memory associated with iteration.

RETURN VALUE

       This call returns the CS_OK value if successful. If cpg_iteration_handle is NULL, CS_ERR_INVALID_PARAM error is	returned.  Same  error	is
       returned  when iteration_type is CPG_ITERATION_ONE_GROUP, but group is NULL, or when group is not NULL and iteration_type is not CPG_ITERA-
       TION_ONE_GROUP. If there is not enough memory for internal store of data, CS_ERR_NO_MEMORY is returned. CS_ERR_BAD_HANDLE can be  returned,
       if handle is not valid handle.

COMMON IPC 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

       cpg_iteration_next(3), cpg_iteration_finalize(3), cpg_initialize(3), cpg_overview(8)

corosync Man Page						    05/03/2012					       CPG_ITERATION_INITIALIZE(3)