| Newsgroups |
gmane.network.spread.cvs |
| Message-ID |
<[email protected]> |
Author: jonathan
Date: 2005-08-08 00:53:24 -0400 (Mon, 08 Aug 2005)
New Revision: 262
Added:
trunk/docs/SP_get_first_vs_set_offset_memb_mess.3
trunk/docs/SP_get_gid_offset_memb_mess.3
trunk/docs/SP_get_local_vs_set_offset_memb_mess.3
trunk/docs/SP_get_local_vs_set_offset_memb_scat.3
trunk/docs/SP_get_num_vs_sets_offset_memb_mess.3
trunk/docs/SP_get_vs_set_members_offset_vs_set.3
trunk/docs/SP_get_vs_set_size_offset_vs_set.3
trunk/docs/SP_kill.3
trunk/docs/SP_version.3
Modified:
trunk/docs/SP_disconnect.3
Log:
Update man pages for SP_ functions and add new pages for SP_get_*
functions that query the location of fields in the body of
membership messages.
Modified: trunk/docs/SP_disconnect.3
===================================================================
--- trunk/docs/SP_disconnect.3 2005-08-08 04:13:53 UTC (rev 261)
+++ trunk/docs/SP_disconnect.3 2005-08-08 04:53:24 UTC (rev 262)
@@ -15,6 +15,15 @@
other connections still open to the daemon and may open a new
connection after disconnecting.
+If any SP_ function returns a
+.B CONNECTION_CLOSED
+or
+.B NET_ERRROR_ON_SESSION
+error on any call, then the mailbox cannot be used anymore
+until it is disconnected with a call to this function and then
+reconnected by calling SP_connect(). Any other SP_ calls
+will only immediately return the same error value.
+
The
.I mbox
should be for the connection you wish to disconnect from.
Added: trunk/docs/SP_get_first_vs_set_offset_memb_mess.3
===================================================================
--- trunk/docs/SP_get_first_vs_set_offset_memb_mess.3 2005-08-08 04:13:53 UTC (rev 261)
+++ trunk/docs/SP_get_first_vs_set_offset_memb_mess.3 2005-08-08 04:53:24 UTC (rev 262)
@@ -0,0 +1,26 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH SP_ERROR 3 "JULY 2005" SPREAD "User Manuals"
+.SH NAME
+SP_get_first_vs_set_offset_memb_mess \- Offset to first VS Set in Membership message
+.SH SYNOPSIS
+.B #include <sp.h>
+.br
+.BI "int SP_get_first_vs_set_offset_memb_mess( void );"
+.SH DESCRIPTION
+.B SP_get_first_vs_set_offset_memb_mess
+returns the byte offset of the beginning of the first VS set stored in the membership mesage.
+.SH "RETURN VALUES"
+Returns value.
+.SH BUGS
+None.
+.SH AUTHOR
+Yair Amir <[email protected]>
+.br
+Jonathan Stanton <[email protected]>
+.br
+Commedia Project <[email protected]>
+.SH "SEE ALSO"
+.BR libsp(3)
+
Added: trunk/docs/SP_get_gid_offset_memb_mess.3
===================================================================
--- trunk/docs/SP_get_gid_offset_memb_mess.3 2005-08-08 04:13:53 UTC (rev 261)
+++ trunk/docs/SP_get_gid_offset_memb_mess.3 2005-08-08 04:53:24 UTC (rev 262)
@@ -0,0 +1,26 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH SP_ERROR 3 "JULY 2005" SPREAD "User Manuals"
+.SH NAME
+SP_get_gid_offset_memb_mess \- Group ID offset in Membership message
+.SH SYNOPSIS
+.B #include <sp.h>
+.br
+.BI "int SP_get_gid_offset_memb_mess( void );"
+.SH DESCRIPTION
+.B SP_get_gid_offset_memb_mess
+returns the byte offset of the group ID field in the body of a membership message.
+.SH "RETURN VALUES"
+Returns value.
+.SH BUGS
+None.
+.SH AUTHOR
+Yair Amir <[email protected]>
+.br
+Jonathan Stanton <[email protected]>
+.br
+Commedia Project <[email protected]>
+.SH "SEE ALSO"
+.BR libsp(3)
+
Added: trunk/docs/SP_get_local_vs_set_offset_memb_mess.3
===================================================================
--- trunk/docs/SP_get_local_vs_set_offset_memb_mess.3 2005-08-08 04:13:53 UTC (rev 261)
+++ trunk/docs/SP_get_local_vs_set_offset_memb_mess.3 2005-08-08 04:53:24 UTC (rev 262)
@@ -0,0 +1,30 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH SP_ERROR 3 "JULY 2005" SPREAD "User Manuals"
+.SH NAME
+SP_get_local_vs_set_offset_memb_mess \- Offset to beginning of local VS Set in Membership message
+.SH SYNOPSIS
+.B #include <sp.h>
+.br
+.BI "int SP_get_local_vs_set_offset_memb_mess( char *" reg_memb_mess );
+.SH DESCRIPTION
+.B SP_get_local_vs_set_offset_memb_mess
+returns the byte offset of the beginning of the local client's VS Set in the body of a membership message.
+Unlike other SP_get_* functions, the value returned can be different for every receiver.
+The
+.I reg_memb_mess
+should be the body of a received membership message.
+.SH "RETURN VALUES"
+Returns value.
+.SH BUGS
+None.
+.SH AUTHOR
+Yair Amir <[email protected]>
+.br
+Jonathan Stanton <[email protected]>
+.br
+Commedia Project <[email protected]>
+.SH "SEE ALSO"
+.BR libsp(3)
+
Added: trunk/docs/SP_get_local_vs_set_offset_memb_scat.3
===================================================================
--- trunk/docs/SP_get_local_vs_set_offset_memb_scat.3 2005-08-08 04:13:53 UTC (rev 261)
+++ trunk/docs/SP_get_local_vs_set_offset_memb_scat.3 2005-08-08 04:53:24 UTC (rev 262)
@@ -0,0 +1,30 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH SP_ERROR 3 "JULY 2005" SPREAD "User Manuals"
+.SH NAME
+SP_get_local_vs_set_offset_memb_mess \- Offset to beginning of local VS Set in Membership message
+.SH SYNOPSIS
+.B #include <sp.h>
+.br
+.BI "int SP_get_local_vs_set_offset_memb_scat( const scatter *" reg_memb_scat );
+.SH DESCRIPTION
+.B SP_get_local_vs_set_offset_memb_scat
+returns the byte offset of the beginning of the local client's VS Set in the body of a membership message.
+Unlike other SP_get_* functions, the value returned can be different for every receiver.
+The
+.I reg_memb_scat
+should be the scatter storing the body of a received membership message.
+.SH "RETURN VALUES"
+Returns value.
+.SH BUGS
+None.
+.SH AUTHOR
+Yair Amir <[email protected]>
+.br
+Jonathan Stanton <[email protected]>
+.br
+Commedia Project <[email protected]>
+.SH "SEE ALSO"
+.BR libsp(3)
+
Added: trunk/docs/SP_get_num_vs_sets_offset_memb_mess.3
===================================================================
--- trunk/docs/SP_get_num_vs_sets_offset_memb_mess.3 2005-08-08 04:13:53 UTC (rev 261)
+++ trunk/docs/SP_get_num_vs_sets_offset_memb_mess.3 2005-08-08 04:53:24 UTC (rev 262)
@@ -0,0 +1,27 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH SP_ERROR 3 "JULY 2005" SPREAD "User Manuals"
+.SH NAME
+SP_get_offset_to_local_vs_set_offset \- Offset to integer storing the offset to the local VS Set in Membership message
+.SH SYNOPSIS
+.B #include <sp.h>
+.br
+.BI "int SP_get_offset_to_local_vs_set_offset( void );"
+.SH DESCRIPTION
+.B SP_get_offset_to_local_vs_set_offset
+returns the byte offset of the integer storing the offset that locates the local VS Set belonging to the client who
+received the membership message. This value could be different for each receiver.
+.SH "RETURN VALUES"
+Returns value.
+.SH BUGS
+None.
+.SH AUTHOR
+Yair Amir <[email protected]>
+.br
+Jonathan Stanton <[email protected]>
+.br
+Commedia Project <[email protected]>
+.SH "SEE ALSO"
+.BR libsp(3)
+
Added: trunk/docs/SP_get_vs_set_members_offset_vs_set.3
===================================================================
--- trunk/docs/SP_get_vs_set_members_offset_vs_set.3 2005-08-08 04:13:53 UTC (rev 261)
+++ trunk/docs/SP_get_vs_set_members_offset_vs_set.3 2005-08-08 04:53:24 UTC (rev 262)
@@ -0,0 +1,27 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH SP_ERROR 3 "JULY 2005" SPREAD "User Manuals"
+.SH NAME
+SP_get_vs_set_members_offset_vs_set \- Offset to member list of current VS Set in Membership message
+.SH SYNOPSIS
+.B #include <sp.h>
+.br
+.BI "int SP_get_vs_set_members_offset_vs_set( void );"
+.SH DESCRIPTION
+.B SP_get_vs_set_members_offset_vs_set
+returns the byte offset to the member list of a VS set stored in the membership mesage. The
+offset is relative to the beginning of the specific VS set entry.
+.SH "RETURN VALUES"
+Returns value.
+.SH BUGS
+None.
+.SH AUTHOR
+Yair Amir <[email protected]>
+.br
+Jonathan Stanton <[email protected]>
+.br
+Commedia Project <[email protected]>
+.SH "SEE ALSO"
+.BR libsp(3)
+
Added: trunk/docs/SP_get_vs_set_size_offset_vs_set.3
===================================================================
--- trunk/docs/SP_get_vs_set_size_offset_vs_set.3 2005-08-08 04:13:53 UTC (rev 261)
+++ trunk/docs/SP_get_vs_set_size_offset_vs_set.3 2005-08-08 04:53:24 UTC (rev 262)
@@ -0,0 +1,27 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH SP_ERROR 3 "JULY 2005" SPREAD "User Manuals"
+.SH NAME
+SP_get_vs_set_size_offset_vs_set \- Offset to size of current VS Set in Membership message
+.SH SYNOPSIS
+.B #include <sp.h>
+.br
+.BI "int SP_get_vs_set_size_offset_vs_set( void );"
+.SH DESCRIPTION
+.B SP_get_vs_set_size_offset_vs_set
+returns the byte offset to the size field of a VS set stored in the membership mesage. The
+offset is relative to the beginning of the specific VS set entry.
+.SH "RETURN VALUES"
+Returns value.
+.SH BUGS
+None.
+.SH AUTHOR
+Yair Amir <[email protected]>
+.br
+Jonathan Stanton <[email protected]>
+.br
+Commedia Project <[email protected]>
+.SH "SEE ALSO"
+.BR libsp(3)
+
Added: trunk/docs/SP_kill.3
===================================================================
--- trunk/docs/SP_kill.3 2005-08-08 04:13:53 UTC (rev 261)
+++ trunk/docs/SP_kill.3 2005-08-08 04:53:24 UTC (rev 262)
@@ -0,0 +1,51 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH SP_DISCONNECT 3 "JULY 2005" SPREAD "User Manuals"
+.SH NAME
+SP_kill \- close a client side connection without notifying the daemon.
+.SH SYNOPSIS
+.B #include <sp.h>
+.br
+.BI "int SP_kill( mailbox " mbox );
+.SH DESCRIPTION
+.B SP_kill
+should be called when the application needs to close
+a connection to the Spread daemon, but does not want to notify the
+daemon about the close. The most common case of needing this is when a
+Spread clienta application calls the unix function
+.B fork()
+and needs to close the connection in either the parent or child since the other
+will handle the communcation.
+
+Generally the
+.B SP_disconnect() function should be used to disconnect from the daemon as it
+correctly and expediently notifies the daemon about the disconnection. If a client
+calls
+.B SP_kill
+instead of SP_disconnect when no other process has the client side mbox open (because
+of fork) then the network connection to the daemon will be closed and the daemon
+will detect the client as disconnected as soon as the network layer (TCP) registers
+a closed socket on the daemon side. Thus it will appear to the daemon as if a true
+network fault occurred or the client crashed as opposed to cleanly disconnecting.
+
+The
+.I mbox
+should be for the connection you wish to close the mbox on.
+.SH "RETURN VALUES"
+Returns 0 on success or
+.B ILLEGAL_SESSION
+when the session
+.I mbox
+given is not a valid connection.
+.SH BUGS
+None.
+.SH AUTHOR
+Yair Amir <[email protected]>
+.br
+Jonathan Stanton <[email protected]>
+.br
+Commedia Project <[email protected]>
+.SH "SEE ALSO"
+.BR libsp (3)
+
Added: trunk/docs/SP_version.3
===================================================================
--- trunk/docs/SP_version.3 2005-08-08 04:13:53 UTC (rev 261)
+++ trunk/docs/SP_version.3 2005-08-08 04:53:24 UTC (rev 262)
@@ -0,0 +1,28 @@
+.\" Process this file with
+.\" groff -man -Tascii foo.1
+.\"
+.TH SP_POLL 3 "JULY 2005" SPREAD "User Manuals"
+.SH NAME
+SP_version \- returns the three component version number of the Spread library
+.SH SYNOPSIS
+.B #include <sp.h>
+.br
+.BI "int SP_version( int *" major_version, "int *" minor_version, "int *" patch_version );
+.SH DESCRIPTION
+.B SP_version
+is a way to retrieve the current version of the Spread library that is linked with the client
+application. This may not be the same version number as the daemon that the client connects
+to. This function does not require any network communication.
+.SH "RETURN VALUES"
+Returns 0 if the parameters are invalid pointers, or returns one and sets the parameters to appropriate version numbers if they are valid.
+.SH BUGS
+None.
+.SH AUTHOR
+Yair Amir <[email protected]>
+.br
+Jonathan Stanton <[email protected]>
+.br
+Commedia Project <[email protected]>
+.SH "SEE ALSO"
+.BR libsp (3)
+