From dabb80c77773a5cd37944e37a8cca2e7f6265835 Mon Sep 17 00:00:00 2001 From: dkf Date: Wed, 19 Sep 2001 10:57:32 +0000 Subject: Socket documentation improvement. --- ChangeLog | 5 +++++ doc/socket.n | 10 +++++++--- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/ChangeLog b/ChangeLog index 0e27b4b..f11e877 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,10 @@ 2001-09-19 Donal K. Fellows + * doc/socket.n: Added documentation to mention what happens when a + server socket is created with port=0. Removed an old change bar, + and no new change bar because Tcl has always behaved this way as + it is really a poorly-documented standards-defined OS feature. + * tests/util.test (util-8.1): Test derived from code to detect the problem, but the test always works in the C locale, so beware if you are maintaining the code. 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 -- cgit v0.12