evs_join(3) [debian man page]

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

NAME

       evs_join - Joins one or more groups in the EVS library

SYNOPSIS

       #include <corosync/evs.h>

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

DESCRIPTION

       The evs_join function is used to join one or more groups.  When a group is joined, using the evs_mcast_joined(3) function will multicast to
       the groups joined in the argument handle.  Messages that are sent to any of the groups joined to the parameter handle will be delivered	by
       evs_dispatch(3).

       This call may be used more then once on a handle, in which case the joined groups will be all of the groups passed to the evs_join(3) func-
       tion during the lifecycle of the parameter handle.

       The argument groups is used to specify the groups to join.  A group is a 32 byte key.  The key is not a string, hence, the  entire  key	is
       used when joining 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_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_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)