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

FreeBSD Manual Pages

  
 
  

home | help
SP_GET_VS_SETS_INFO(3)		 User Manuals		SP_GET_VS_SETS_INFO(3)

NAME
       SP_get_vs_sets_info, SP_scat_get_vs_sets_info - Extract list of VS sets
       from membership message

SYNOPSIS
       #include	<sp.h>

       int SP_get_vs_sets_info(	const char * memb_mess,	vs_set_info  *vs_sets,
       int num_vs_sets,	unsigned int *my_vs_set_index);
       int   SP_scat_get_vs_sets_info(	 const	 scatter   *   memb_mess_scat,
       vs_set_info *vs_sets, int num_vs_sets, unsigned int *my_vs_set_index);

DESCRIPTION
       SP_get_vs_sets_info and its scatter variant extract the list of VS sets
       provided	 in  a	Network	 membership  message  and  store them into the
       vs_sets array of	vs_set_info structs. The number	of elements in the ar-
       ray should be provided in the num_vs_sets parameter.

       This function also returns an index of which VS set in the array	corre-
       sponds to the current process's VS set. That index value	is returned in
       the my_vs_set_index parameter.

       The  memb_mess  field or	scatter	field  should be the body of a message
       that was	returned in a previous SP_receive call for a  membership  mes-
       sage.

       The fields of a vs_set_info struct include

	      unsigned int num_members

	      unsigned int member_offset

       The  member_offset field	is the byte offset into	the membership message
       body where  this	 VS  set's  member  list  begins.   For	 each  of  the
       vs_set_info  records  in	 the array, the	function SP_get_vs_set_members
       will grab the actual array of member names for the specified VS set.

RETURN VALUES
       Returns a postivive value on success or one of the following errors ( <
       0 ):

       BUFFER_TOO_SHORT
	       The  allocated  array  of  vs_set_info structs can not hold the
	       number of VS sets contained in this membership message. No data
	       is  parsed.  Reallocate	a  larger array	of vs_set_info structs
	       (the  required  number  is  available  in  the  membership_info
	       struct) and call	this function again.

BUGS
       None.

AUTHOR
       Yair Amir <yairamir@cnds.jhu.edu>
       Jonathan	Stanton	<jonathan@cnds.jhu.edu>

SEE ALSO
       libspread(3)

SPREAD				 February 2006		SP_GET_VS_SETS_INFO(3)

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | BUGS | AUTHOR | SEE ALSO

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

home | help