summaryrefslogtreecommitdiffstats
path: root/doc/socket.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2001-09-19 10:57:32 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2001-09-19 10:57:32 (GMT)
commitdabb80c77773a5cd37944e37a8cca2e7f6265835 (patch)
tree044fc4599cbce5385565455b8d9fca781840284c /doc/socket.n
parent000f29b52802a11b293d0629589c2a7aa652cda7 (diff)
downloadtcl-dabb80c77773a5cd37944e37a8cca2e7f6265835.zip
tcl-dabb80c77773a5cd37944e37a8cca2e7f6265835.tar.gz
tcl-dabb80c77773a5cd37944e37a8cca2e7f6265835.tar.bz2
Socket documentation improvement.
Diffstat (limited to 'doc/socket.n')
-rw-r--r--doc/socket.n10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/socket.n b/doc/socket.n
index 8c269db..4fe53f4 100644
--- a/doc/socket.n
+++ b/doc/socket.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: socket.n,v 1.5 1999/08/21 19:40:48 hobbs Exp $
+'\" RCS: @(#) $Id: socket.n,v 1.6 2001/09/19 10:57:32 dkf Exp $
.so man.macros
.TH socket n 8.0 Tcl "Tcl Built-In Commands"
.BS
@@ -100,18 +100,22 @@ new connections are opened. If the application doesn't enter the
event loop, for example by invoking the \fBvwait\fR command or
calling the C procedure \fBTcl_DoOneEvent\fR, then no connections
will be accepted.
+.PP
+If \fIport\fR is specified as zero, the operating system will allocate
+an unused port for use as a server socket. The port number actually
+allocated my be retrieved from the created server socket using the
+\fBfconfigure\fR command to retrieve the \fB\-sockname\fR option as
+described below.
.SH "CONFIGURATION OPTIONS"
The \fBfconfigure\fR command can be used to query several readonly
configuration options for socket channels:
-.VS 8.0.5
.TP
\fB\-error\fR
This option gets the current error status of the given socket. This
is useful when you need to determine if an asynchronous connect
operation succeeded. If there was an error, the error message is
returned. If there was no error, an empty string is returned.
-.VE 8.0.5
.TP
\fB\-sockname\fR
This option returns a list of three elements, the address, the host name