File: SP_poll.3

package info (click to toggle)
spread 3.17.4-2
  • links: PTS
  • area: main
  • in suites: lenny, squeeze
  • size: 1,800 kB
  • ctags: 2,322
  • sloc: ansic: 15,666; sh: 2,611; java: 2,291; perl: 556; yacc: 523; makefile: 255; lex: 204; xml: 77
file content (34 lines) | stat: -rw-r--r-- 883 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
.\" Process this file with
.\" groff -man -Tascii foo.1
.\"
.TH SP_POLL 3 "JULY 1998" SPREAD "User Manuals"
.SH NAME
SP_poll \- checks amount of data ready to be read
.SH SYNOPSIS
.B #include <sp.h>
.br
.BI "int SP_poll( mailbox " mbox );
.SH DESCRIPTION
.B SP_poll
is a way to poll a mailbox to see if any messages are
available for receiving. The value returned will be < 0 if error,
0 if nothing is available, and the number of bytes waiting if
something is there.
.SH "RETURN VALUES"
Returns 0 if nothing is available or the number of bytes available, or one of the following errors ( < 0 ):
.TP 0.8i
.B ILLEGAL_SESSION
The session specified by
.I mbox
is illegal. Usually because it is not active.
.SH BUGS
None.
.SH AUTHOR
Yair Amir <yairamir@cnds.jhu.edu>
.br
Jonathan Stanton <jonathan@cnds.jhu.edu>
.br
Commedia Project <commedia@cnds.jhu.edu>
.SH "SEE ALSO"
.BR libsp (3)