Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CPG_LEAVE(3)	  Corosync Cluster Engine Programmer's Manual	  CPG_LEAVE(3)

NAME
       cpg_leave - Leave a group in the	CPG library

SYNOPSIS
       #include	<corosync/cpg.h>

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

DESCRIPTION
       The cpg_leave function is used to leave a group.	 Once a	group has been
       left the	process	will no	longer receive messages	or notifications about
       events  in that group.  Note that a process is only deemed to have left
       the group once it has been notified (by its confchg callback)  that  is
       has  left.   So	expect	to receive at least one	confchg	callback after
       calling this function.

       The argument group is used to specify the group to leave.  It  is  cur-
       rently  ignored	as  only one group can be joined per handle. It	is in-
       cluded here for to allow	for future development.

RETURN VALUE
       This call returns the CS_OK value if successful,	otherwise an error  is
       returned.

ERRORS
       The errors are undocumented.

SEE ALSO
       cpg_overview(3),	  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_lo-
       cal_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 interrupted	by a signal

       CS_ERR_NOT_SUPPORTED The	requested protocol/functionality not supported

       CS_ERR_MESSAGE_ERROR Incorrect auth message received

       CS_ERR_NO_MEMORY	Not enough memory to complete the requested task

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

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=cpg_leave&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help