cpg_join(3) [suse 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 CPG_OK value if successful, CPG_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)

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

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

NAME

       cpg_mcast_joined - Multicasts a zero copy buffer to all groups joined to a handle

SYNOPSIS

       #include <sys/uio.h> #include <corosync/cpg.h>

       int cpg_zcb_mcast_joined(cpg_handle_t handle, cpg_guarantee_t guarantee, const void *buffer,int msg_len );

DESCRIPTION

       The cpg_zcb_mcast_joined function will multicast a zero copy buffer message to all the processes that have been joined with the cpg_join(3)
       funtion for the same group name.  Messages that are sent to any of the groups joined to the parameter handle will be delivered to all  sub-
       scribed processes in the system.

       The argument guarantee requests a delivery guarantee for the message to be sent.  The cpg_guarantee_t type is defined by:

	      typedef enum {
		      CPG_TYPE_UNORDERED,     /* not implemented */
		      CPG_TYPE_FIFO,	      /* same as agreed */
		      CPG_TYPE_AGREED,	      /* implemented */
		      CPG_TYPE_SAFE	      /* not implemented */
	      } cpg_guarantee_t;

       The meanings of the cpg_guarantee_t typedef are:

       CPG_TYPE_UNORDERED
	      Messages are guaranteed to be delivered, but with no particular order.  This mode is unimplemented in the CPG library.

       CPG_TYPE_FIFO
	      Messages	are  guaranteed  to  be  delivered  in	first  sent  first  delivery  order.  In fact, this guarantee is equivalent to the
	      CPG_TYPE_AGREED guarantee.

       CPG_TYPE_AGREED
	      All processors must agree on the order of delivery.  If a message is sent from two or more processes at about  the  same	time,  the
	      delivery will occur in the same order to all processes.

       CPG_TYPE_SAFE
	      All  processes must agree on the order of delivery.  Further all processes must have a copy of the message before any delivery takes
	      place.  This mode is unimplemented in the CPG library.

       The msg argument describes the zero copy buffer which is used to transmit a message.  this buffer must be allocated by cpg_zcb_alloc(3).

       The msg_len argument describes the number of bytes to be transmitted in the zero copy buffer.

RETURN VALUE

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

ERRORS

       The errors are undocumented.

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)

corosync Man Page						    3004-08-31						   CPG_ZCB_MCAST_JOINED(3)