From 1d3c7f0cdf1c3b528ce39d8bf41ec82af4addaa2 Mon Sep 17 00:00:00 2001
From: dkf <donal.k.fellows@manchester.ac.uk>
Date: Thu, 20 May 2004 22:58:14 +0000
Subject: Added examples

---
 doc/vwait.n | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/doc/vwait.n b/doc/vwait.n
index 4febe1b..6cd8be2 100644
--- a/doc/vwait.n
+++ b/doc/vwait.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: vwait.n,v 1.4 2000/09/07 14:27:52 poenitz Exp $
+'\" RCS: @(#) $Id: vwait.n,v 1.5 2004/05/20 22:58:14 dkf Exp $
 '\" 
 .so man.macros
 .TH vwait n 8.0 Tcl "Tcl Built-In Commands"
@@ -35,6 +35,44 @@ if an event handler sets \fIvarName\fR and then itself calls
 for a long time.  During this time the top-level \fBvwait\fR is
 blocked waiting for the event handler to complete, so it cannot
 return either.
+.SH EXAMPLES
+Run the event-loop continually until some event calls \fBexit\fR.
+(You can use any variable not mentioned elsewhere, but the name
+\fIforever\fR reminds you at a glance of the intent.)
+.CS
+vwait forever
+.CE
+
+Wait five seconds for a connection to a server socket, otherwise
+close the socket and continue running the script:
+.CS
+# Initialise the state
+after 5000 set state timeout
+set server [socket -server accept 12345]
+proc accept {args} {
+   global state connectionInfo
+   set state accepted
+   set connectionInfo $args
+}
+
+# Wait for something to happen
+vwait state
+
+# Clean up events that could have happened
+close $server
+after cancel set state timeout
+
+# Do something based on how the vwait finished...
+switch $state {
+   timeout {
+      puts "no connection on port 12345"
+   }
+   accepted {
+      puts "connection: $connectionInfo"
+      puts [lindex $connectionInfo 0] "Hello there!"
+   }
+}
+.CE
 
 .SH "SEE ALSO"
 global(n)
-- 
cgit v0.12