summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authoroehhar <harald.oehlmann@elmicron.de>2014-12-17 08:22:23 (GMT)
committeroehhar <harald.oehlmann@elmicron.de>2014-12-17 08:22:23 (GMT)
commitd7699753fccbdc293c9e954833f62e623b5cbfd1 (patch)
tree965fd82f8c22b9bb8ad71274378591d94b4d7569
parent691e34c6ccbee85bbd91e420504983345029d5ea (diff)
downloadtcl-tip_427.zip
tcl-tip_427.tar.gz
tcl-tip_427.tar.bz2
Documented "fconfigure $h -connecting" on socket man pagetip_427
-rw-r--r--doc/socket.n9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/socket.n b/doc/socket.n
index b7a4a45..492ca66 100644
--- a/doc/socket.n
+++ b/doc/socket.n
@@ -97,6 +97,10 @@ writable channel event on the socket to get notified when the
asynchronous connection has succeeded or failed. See the \fBvwait\fR
and the \fBchan\fR commands for more details on the event loop and
channel events.
+.PP
+The \fBchan configure\fR option \fB-connecting\fR may be used to check if the connect is still running. To verify a successful connect, the option \fB-error\fR may be checked when \fB-connecting\fR returned 0.
+.PP
+Operation without the event queue requires at the moment calls to \fBchan configure\fR to advance the internal state machine.
.RE
.SH "SERVER SOCKETS"
.PP
@@ -186,6 +190,11 @@ sockets, this option returns a list of three elements; these are the
address, the host name and the port to which the peer socket is connected
or bound. If the host name cannot be computed, the second element of the
list is identical to the address, its first element.
+.RE
+.TP
+\fB\-connecting\fR
+.
+This option is not supported by server sockets. For client sockets, this option returns 1 if an asyncroneous connect is still in progress, 0 otherwise.
.PP
.SH "EXAMPLES"
.PP