[Spread-cvs] cvs commit: spread/daemon/docs SP_receive.3

[jonathan at spread.org]

jonathan    02/09/18 00:46:56

  Modified:    daemon/docs SP_receive.3
  Log:
  Update docs with info on new accessor functions. Small final update to
  Readme.txt. This version will be tagged RC1.
  
  Revision  Changes    Path
  1.4       +21 -27    spread/daemon/docs/SP_receive.3
  
  Index: SP_receive.3
  ===================================================================
  RCS file: /storage/cvsroot/spread/daemon/docs/SP_receive.3,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- SP_receive.3	26 Aug 2002 22:57:41 -0000	1.3
  +++ SP_receive.3	18 Sep 2002 00:46:56 -0000	1.4
  @@ -1,7 +1,7 @@
   .\" Process this file with
   .\" groff -man -Tascii foo.1
   .\"
  -.TH SP_RECEIVE 3 "April 2002" Spread "User Manuals"
  +.TH SP_RECEIVE 3 "September 2002" Spread "User Manuals"
   .SH NAME
   SP_receive, SP_scat_receive \- Receive message from Spread
   .SH SYNOPSIS
  @@ -193,36 +193,43 @@
   The second set of information is stored in the message body and provides a list
   of all the private group names of those processes which came with your process
   from the old group membership into this new membership. The data buffer will include
  -the following fixed length fields:
  +the following fields:
   
   .RS
   .TP
   .B group_id;
   .br
   .TP
  -.B int num_members;
  +.B int num_vs_members;
   .br
   .TP
  -.B char groups[][MAX_GROUP_NAME];
  +.B char vs_set[][MAX_GROUP_NAME];
   .RE
   
  -The groups array will have num_members group names, each of which is
  -a fixed length string.  The content of the groups array is dependent 
  +The location of the beginning of each field is provided by the accessor functions
  +.B SP_get_gid_offset_memb_mess,
  +.B SP_get_num_vs_offset_memb_mess, and
  +.B SP_get_vs_set_offset_memb_mess.
  +Each accessor function gives the byte offset in the message body of the corresponding
  +field. 
  +
  +The vs_set array will have num_vs_members group names, each of which is
  +a fixed length string.  The content of the vs_set array is dependent 
   upon the type of the membership change:
   
   .RS
   .TP 0.8i
   .B CAUSED_BY_JOIN:
  -Groups contains the private group of the joining process.
  +Vs_set contains the private group of the joining process.
   .TP
   .B CAUSED_BY_LEAVE:
  -Groups contains the private group of the leaving process.
  +Vs_set contains the private group of the leaving process.
   .TP
   .B CAUSED_BY_DISCONNECT:
  -Groups contains the private group of the disconnecting process.
  +Vs_set contains the private group of the disconnecting process.
   .TP
   .B CAUSED_BY_NETWORK:
  -Groups contains the group names of the members of the new membership who came 
  +Vs_set contains the group names of the members of the new membership who came 
   with 
   .B me
   (the current process) to the new membership. Of course, all 
  @@ -281,23 +288,10 @@
   The second set of information is stored in the message body and provides a the
   private group name of the member who just left, which should always be the
   private group name of the connection which received this message.
  -The data buffer will include the following fixed length fields:
  -
  -.RS
  -.TP
  -.B group_id;
  -.br
  -.TP
  -.B int num_members;
  -.br
  -.TP
  -.B char groups[][MAX_GROUP_NAME];
  -.RE
  -
  -The groups array will have num_members group names, each of which is
  -a fixed length string.  The content of the groups array will be the 
  -private group of the leaving process, since this case only occurs with
  -a CAUSED_BY_LEAVE membership change.
  +The private group name can be accessed at a byte offset from the beginning of 
  +the buffer given by the 
  +.B SP_get_vs_set_offset_memb_mess
  +function. The name will consist of one fixed length string of MAX_GROUP_NAME size.
   
   .SH "RETURN VALUES"
   Returns the size of the message received