scsh-conservatory
/
scsh-0.6
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added documentation for WAIT-PORTS.

This commit is contained in:
sperber 2002-11-28 10:54:22 +00:00
parent a6ec3b5bb5
commit 666f5282f8
2 changed files with 33 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
RELEASE
View File

@ -188,13 +188,14 @@ We manage the project using SourceForge:
checksums. checksums.
** API changes ** API changes
select and select! are supported again select and select! are supported again. Note however, that they
Interface to the uname function are deprecated in favor of the new wait-ports procedure.
Direct interface to the directory stream operations New interface to the uname function.
New direct interface to the directory stream operations
New structure scheme-with-scsh which combines the exports of the New structure scheme-with-scsh which combines the exports of the
modules scsh and scheme modules scsh and scheme, avoiding duplicates
New procdures to work directly on file-info records New procdures to work directly on file-info records
The procedure repl has been removed The repl procedure has been removed
** Bugfixes ** Bugfixes

26
doc/scsh-manual/syscalls.tex
View File

@ -835,9 +835,33 @@ Returns two ports, the read and write end-points of a {\Unix} pipe.
inherent use of \texttt{select}/\texttt{select!} which do not inherent use of \texttt{select}/\texttt{select!} which do not
benefit from multiple threads. Examples are network clients benefit from multiple threads. Examples are network clients
that send requests to multiple alternate servers and discard all that send requests to multiple alternate servers and discard all
but one of them.} but one of them.
In any case, the \texttt{wait-ports} procedure described below
is usually a preferable alternative to
\texttt{select}/\texttt{select!}: it is much simpler to use, and
also has a slightly more efficient implementation.}
\end{desc} \end{desc}
\defun {wait-ports}{timeout port \ldots}{ready-ports}
\begin{desc}
The \ex{wait-ports} call will block until at least one of the ports
passed to it is ready for operation. For an input port this means
that it either has data sitting its buffer or that the underlying
file descriptor has data waiting. For an output port this means
that it either has space available in the associated buffer or that
the underlying file descriptor can accept output.
The \var{timeout} value can be used to force the call to time-out
after a given number of seconds. A value of \ex{\#f} means to wait
indefinitely. A zero value can be used to poll the ports.
\texttt{Wait-ports} returns a list of the ports ready for
operation. Note that this list may be empty if the timeout expired
before any ports became ready.
\end{desc}
\begin{defundescx}{write-string}{string [fd/port start end]}\undefined \begin{defundescx}{write-string}{string [fd/port start end]}\undefined
This procedure writes all the data requested. This procedure writes all the data requested.
If the procedure cannot perform the write with a single kernel call If the procedure cannot perform the write with a single kernel call