.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Spread 3"
.TH Spread 3 "2008-01-14" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Spread \- Perl extension for the Spread group communication system
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Spread;
.Ve
.PP
.Vb 5
\&  # Connect
\&  my($mailbox, $private_group) = Spread::connect(
\&        { spread_name => '4803@host.domain.com',
\&        private_name => 'mrcool', }
\&        );
.Ve
.PP
.Vb 5
\&  # Join and leave groups
\&  my(@group_to_join) = ( 'GroupA', 'GroupB', 'GroupC' );
\&  my(@joined_groups) = grep( Spread::join($mbox, $_), @group_to_join );
\&  print "Spread::join -- $sperrorno"
\&        unless (Spread::leave($mbox, 'GroupC'));
.Ve
.PP
.Vb 3
\&  # Multicast to group(s)
\&  Spread::multicast($mbox, AGREED_MESS, 'GroupB', 0, "Hey you!");
\&  Spread::multicast($mbox, SAFE_MESS, @joined_groups, 0, "Hey yall!");
.Ve
.PP
.Vb 4
\&  # Poll mailbox
\&  my($messsize) = Spread::poll($mbox);
\&  if(defined($messsize)) { print "Next message: $messsize bytes\en"; }
\&  else { print "Spread::poll $sperrno\en"; }
.Ve
.PP
.Vb 5
\&  # Receive messages (see spread's man pages for more description)
\&  my($service_type, $sender, $groups, $mess_type, $endian, $message) =
\&        Spread::receive($mbox);
\&  my($service_type, $sender, $groups, $mess_type, $endian, $message) =
\&        Spread::receive($mbox, 1.789);  # 1.789 second timeout on receive
.Ve
.PP
.Vb 3
\&  # Disconnect
\&  if(Spread::disconnect($mbox)) { print "Successful disconnect\en"; }
\&  else { print "Spread::disconnect -- $sperrorno\en"; }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Understanding through practice ;)
.PP
See man pages for SP_connect, SP_join, SP_multicast, SP_receive,
SP_poll, SP_error, SP_leave, SP_disconnect.
.PP
$sperror holds either the integer spread error or a descriptive string
depending on the context in which \f(CW$sperror\fR is used.
.SH "Exported constants"
.IX Header "Exported constants"
The predefined groups of exports in the use statements are as follows:
.PP
use Spread qw(:SP);
.PP
Exports the Spread::connect, Spread::join, Spread::multicast,
Spread::receive, Spread::poll, Spread::error, Spread::leave, and
Spread::disconnect as SP_connect, SP_join, SP_multicast, SP_receive,
SP_poll, SP_error, SP_leave, and SP_disconnect, respectively.
.PP
use Spread qw(:ERROR);
.PP
Exports all of the error conditions.  Please refer to the SP_* C man
pages as the \*(L"\s-1RETURN\s0 \s-1VALUES\s0\*(R" there have both identical spellings and
meanings.
.PP
use Spread qw(:MESS);
.PP
Exports all of the message types (this is returned as service type by
the Spread::receive function and is the request service type of the
Spread::multicast function).  The actual meaning of these orderings
and assurances are not simple to explain without a basic understanding
of group communication systems.  For more information on this topic,
please visit the Spread web site at http://www.spread.org/
.PP
All constants in alphabetical order:
.PP
.Vb 33
\&  ACCEPT_SESSION
\&  AGREED_MESS
\&  BUFFER_TOO_SHORT
\&  CAUSAL_MESS
\&  CAUSED_BY_DISCONNECT
\&  CAUSED_BY_JOIN
\&  CAUSED_BY_LEAVE
\&  CAUSED_BY_NETWORK
\&  CONNECTION_CLOSED
\&  COULD_NOT_CONNECT
\&  FIFO_MESS
\&  HIGH_PRIORITY
\&  ILLEGAL_GROUP
\&  ILLEGAL_MESSAGE
\&  ILLEGAL_SERVICE
\&  ILLEGAL_SESSION
\&  ILLEGAL_SPREAD
\&  LOW_PRIORITY
\&  MAX_SCATTER_ELEMENTS
\&  MEDIUM_PRIORITY
\&  MEMBERSHIP_MESS
\&  REGULAR_MESS
\&  REG_MEMB_MESS
\&  REJECT_ILLEGAL_NAME
\&  REJECT_NOT_UNIQUE
\&  REJECT_NO_NAME
\&  REJECT_QUOTA
\&  REJECT_VERSION
\&  RELIABLE_MESS
\&  SAFE_MESS
\&  SELF_DISCARD
\&  TRANSITION_MESS
\&  UNRELIABLE_MESS
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Theo Schlossnagle <jesus@cnds.jhu.edu>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Various spread documentation at http://www.spread.org/.