diff options
| author | dkf <donal.k.fellows@manchester.ac.uk> | 2005-12-07 09:30:08 (GMT) |
|---|---|---|
| committer | dkf <donal.k.fellows@manchester.ac.uk> | 2005-12-07 09:30:08 (GMT) |
| commit | cf19c60188b714ac2d1ff99555e8a7a22aecda95 (patch) | |
| tree | ff67e52cbd7647ef4611da0a12937663865e6d59 | |
| parent | 5fac5e25b13ebc15e5a05c4d6969b87aae7ed7eb (diff) | |
| download | tcl-cf19c60188b714ac2d1ff99555e8a7a22aecda95.zip tcl-cf19c60188b714ac2d1ff99555e8a7a22aecda95.tar.gz tcl-cf19c60188b714ac2d1ff99555e8a7a22aecda95.tar.bz2 | |
Improved documentation on topic of asynch sockets in response to queries on
the Tcler's Chat.
| -rw-r--r-- | ChangeLog | 9 | ||||
| -rw-r--r-- | doc/fconfigure.n | 5 | ||||
| -rw-r--r-- | doc/socket.n | 13 |
3 files changed, 22 insertions, 5 deletions
@@ -1,3 +1,10 @@ +2005-12-07 Donal K. Fellows <donal.k.fellows@manchester.ac.uk> + + * doc/socket.n: Cross-referenced the socket documentation better to + the fconfigure documentation on the topic of asynch sockets. + * doc/fconfigure.n: Added keyword to documentation of -blocking option + so that people looking for "asynch" can find it as well. + 2005-12-05 Daniel Steffen <das@users.sourceforge.net> * unix/tclUnixPort.h (Darwin): fix incorrect __DARWIN_UNIX03 configure @@ -10,7 +17,7 @@ * library/tzdata: Regenerated from Olson's tzdata2005p.tar.gz - the 'systemv' changes appear not to affect Tcl's processing of the dates. - + 2005-12-05 Daniel Steffen <das@users.sourceforge.net> * unix/configure.in: move check for fts API to configure.in and run it diff --git a/doc/fconfigure.n b/doc/fconfigure.n index 10e5fb1..e5bb5c5 100644 --- a/doc/fconfigure.n +++ b/doc/fconfigure.n @@ -4,7 +4,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: fconfigure.n,v 1.13 2005/05/10 18:33:59 kennykb Exp $ +'\" RCS: @(#) $Id: fconfigure.n,v 1.14 2005/12/07 09:30:09 dkf Exp $ '\" .so man.macros .TH fconfigure n 8.3 Tcl "Tcl Built-In Commands" @@ -49,7 +49,8 @@ channel can cause the process to block indefinitely. The value of the option must be a proper boolean value. Channels are normally in blocking mode; if a channel is placed into nonblocking mode it will affect the operation of the \fBgets\fR, -\fBread\fR, \fBputs\fR, \fBflush\fR, and \fBclose\fR commands; +\fBread\fR, \fBputs\fR, \fBflush\fR, and \fBclose\fR commands by +allowing them to operate asynchronously; see the documentation for those commands for details. For nonblocking mode to work correctly, the application must be using the Tcl event loop (e.g. by calling \fBTcl_DoOneEvent\fR or diff --git a/doc/socket.n b/doc/socket.n index 201fff0..c2ba501 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.12 2004/10/27 14:24:37 dkf Exp $ +'\" RCS: @(#) $Id: socket.n,v 1.13 2005/12/07 09:30:09 dkf Exp $ .so man.macros .TH socket n 8.0 Tcl "Tcl Built-In Commands" .BS @@ -76,7 +76,16 @@ connection attempt succeeds or fails, if the socket is in blocking mode, the operation will wait until the connection is completed or fails. If the socket is in nonblocking mode and a \fBgets\fR or \fBflush\fR is done on the socket before the connection attempt succeeds or fails, the operation -returns immediately and \fBfblocked\fR on the socket returns 1. +returns immediately and \fBfblocked\fR on the socket returns 1. Synchronous +client sockets may be switched (after they have connected) to operating in +asynchronous mode using: +.RS +.CS +\fBfconfigure \fIchan \fB\-blocking 0\fR +.CE +.PP +See the \fBfconfigure\fR command for more details. +.RE .SH "SERVER SOCKETS" .PP If the \fB\-server\fR option is specified then the new socket |