From 897f40fb7a6a32728c8990521b30fea00a313c28 Mon Sep 17 00:00:00 2001 From: mainzelm Date: Tue, 16 Apr 2002 09:04:13 +0000 Subject: [PATCH] Added documentation for port->socket. --- doc/scsh-manual/network.tex | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/scsh-manual/network.tex b/doc/scsh-manual/network.tex index df55ebd..493ca79 100644 --- a/doc/scsh-manual/network.tex +++ b/doc/scsh-manual/network.tex @@ -124,6 +124,16 @@ is preferred to explicitly closing the inport and outport because using \end{desc} +\defun {port->socket} {port protocol-family} {socket} +\begin{desc} + This procedure turns \var{port} into a socket object. The port's + underlying file descriptor must be a socket with protocol family + \var{protocol-family}. \ex{port->socket} comes in handy for writing + servers which run as children of \texttt{inetd}: after receiving a + connection \texttt{inetd} creates a socket and passes it as + standard input to its child. +\end{desc} + \section{Socket addresses} The format of a socket-address depends on the address family of the