Browse Source

Some cosmetic changes, and return values of Connect and Accept corrected

michael 26 years ago
parent
commit
ec1265f577
1 changed files with 23 additions and 18 deletions
  1. 23 18
      docs/sockets.tex

+ 23 - 18
docs/sockets.tex

@@ -99,35 +99,40 @@ Function Accept (Sock:Longint;Var Addr;Var Addrlen:Longint) : Longint;
 
 
 \Description
 \Description
 \var{Accept} accepts a connection from a socket \var{Sock}, which was
 \var{Accept} accepts a connection from a socket \var{Sock}, which was
-listening for a connection. The accepted socket may NOT be used to accept
-more connections. The original socket remains open.
-The \var{Accept} call fills the address of the connecting entity in \var{Addr},
-and sets its length in \var{Addrlen}. \var{Addr} should be pointing to
-enough space, and \var{Addrlen} should be set to the amount of space
-available, prior to the call.
+listening for a connection. If a connection is accepted, a file descriptor
+is returned. On error \var{-1} is returned. The returned socket may NOT 
+be used to accept more connections.  The original socket remains open.
+
+The \var{Accept} call fills the address of the connecting entity in 
+\var{Addr}, and sets its length in \var{Addrlen}. \var{Addr} should 
+be pointing to enough space, and \var{Addrlen} should be set to the 
+amount of space available, prior to the call.
 
 
 \Errors
 \Errors
-Errors are reported in \var{SocketError}, and include the following:
+On error, \var{-1} is returned, and errors are reported in 
+\var{SocketError}, and include the following:
 \begin{description}
 \begin{description}
-\item[SYS\_EBADF] The socket descriptor is invalid.
-\item[SYS\_ENOTSOCK] The descriptor is not a socket.
-\item[SYS\_EOPNOTSUPP] The socket type doesn't support the \var{Listen}
+\item[SYS\_EBADF]  The socket descriptor is invalid.
+\item[SYS\_ENOTSOCK]  The descriptor is not a socket.
+\item[SYS\_EOPNOTSUPP]  The socket type doesn't support the \var{Listen}
 operation.
 operation.
-\item[SYS\_EFAULT] \var{Addr} points outside your address space.
-\item[SYS\_EWOULDBLOCK] The requested operation would block the process.
+\item[SYS\_EFAULT]  \var{Addr} points outside your address space.
+\item[SYS\_EWOULDBLOCK]  The requested operation would block the process.
 \end{description}
 \end{description}
 
 
 \SeeAlso
 \SeeAlso
 \seef{Listen}, \seef{Connect}
 \seef{Listen}, \seef{Connect}
 \end{function}
 \end{function}
+
 \latex{\inputlisting{sockex/socksvr.pp}}
 \latex{\inputlisting{sockex/socksvr.pp}}
 \html{\input{sockex/socksvr.tex}}
 \html{\input{sockex/socksvr.tex}}
+
 \begin{functionl}{Accept}{AltAAccept}
 \begin{functionl}{Accept}{AltAAccept}
 \Declaration
 \Declaration
 Function Accept (Sock:longint;var addr:string;var SockIn,SockOut:text) : Boolean;
 Function Accept (Sock:longint;var addr:string;var SockIn,SockOut:text) : Boolean;
 
 
 \Description
 \Description
- This is an alternate form of the \seef{Accept} command. It is equivalent
+This is an alternate form of the \seef{Accept} command. It is equivalent
 to subsequently calling the regular \seef{Accept}
 to subsequently calling the regular \seef{Accept}
 function and the \seep{Sock2Text} function.
 function and the \seep{Sock2Text} function.
 The function returns \var{True} if successfull, \var{False} otherwise.
 The function returns \var{True} if successfull, \var{False} otherwise.
@@ -158,7 +163,6 @@ The errors are those of \seef{Accept}.
 \begin{functionl}{Accept}{AltCAccept}
 \begin{functionl}{Accept}{AltCAccept}
 \Declaration
 \Declaration
 Function Accept (Sock:longint;var addr:TInetSockAddr;var SockIn,SockOut:File) : Boolean;
 Function Accept (Sock:longint;var addr:TInetSockAddr;var SockIn,SockOut:File) : Boolean;
-
 \Description
 \Description
  This is an alternate form of the \seef{Accept} command. 
  This is an alternate form of the \seef{Accept} command. 
 It is equivalent
 It is equivalent
@@ -217,14 +221,15 @@ Function Connect (Sock:Longint;Var Addr;Addrlen:Longint) : Longint;
 
 
 \Description
 \Description
 \var{Connect} opens a connection to a peer, whose address is described by
 \var{Connect} opens a connection to a peer, whose address is described by
-var{Addr}. \var{AddrLen} contains the length of the address.
+\var{Addr}. \var{AddrLen} contains the length of the address.
 The type of \var{Addr} depends on the kind of connection you're trying to
 The type of \var{Addr} depends on the kind of connection you're trying to
 make, but is generally one of \var{TSockAddr} or \var{TUnixSockAddr}.
 make, but is generally one of \var{TSockAddr} or \var{TUnixSockAddr}.
 
 
-The \var{Connect} functions returns a file descriptor if the call
-was successfull, a negative value in case of error.
+The \var{Connect} function returns a file descriptor if the call
+was successfull, \var{-1} in case of error.
 \Errors
 \Errors
-Errors are reported in \var{SocketError}.
+On error, \var{-1} is returned and errors are reported in 
+\var{SocketError}.
 \SeeAlso
 \SeeAlso
 \seef{Listen}, \seef{Bind},\seef{Accept}
 \seef{Listen}, \seef{Bind},\seef{Accept}
 \end{function}
 \end{function}