util/X86LINUX64/man/mann/vwait.n

   1 '\"
   2 '\" Copyright (c) 1995-1996 Sun Microsystems, Inc.
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 .TH vwait n 8.0 Tcl "Tcl Built-In Commands"
   8 .\" The -*- nroff -*- definitions below are for supplemental macros used
   9 .\" in Tcl/Tk manual entries.
  10 .\"
  11 .\" .AP type name in/out ?indent?
  12 .\"     Start paragraph describing an argument to a library procedure.
  13 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  14 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  15 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  16 .\"     needed;  use .AS below instead)
  17 .\"
  18 .\" .AS ?type? ?name?
  19 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  20 .\"     name are examples of largest possible arguments that will be passed
  21 .\"     to .AP later.  If args are omitted, default tab stops are used.
  22 .\"
  23 .\" .BS
  24 .\"     Start box enclosure.  From here until next .BE, everything will be
  25 .\"     enclosed in one large box.
  26 .\"
  27 .\" .BE
  28 .\"     End of box enclosure.
  29 .\"
  30 .\" .CS
  31 .\"     Begin code excerpt.
  32 .\"
  33 .\" .CE
  34 .\"     End code excerpt.
  35 .\"
  36 .\" .VS ?version? ?br?
  37 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  38 .\"     of man pages.  The first argument is ignored and used for recording
  39 .\"     the version when the .VS was added, so that the sidebars can be
  40 .\"     found and removed when they reach a certain age.  If another argument
  41 .\"     is present, then a line break is forced before starting the sidebar.
  42 .\"
  43 .\" .VE
  44 .\"     End of vertical sidebar.
  45 .\"
  46 .\" .DS
  47 .\"     Begin an indented unfilled display.
  48 .\"
  49 .\" .DE
  50 .\"     End of indented unfilled display.
  51 .\"
  52 .\" .SO ?manpage?
  53 .\"     Start of list of standard options for a Tk widget. The manpage
  54 .\"     argument defines where to look up the standard options; if
  55 .\"     omitted, defaults to "options". The options follow on successive
  56 .\"     lines, in three columns separated by tabs.
  57 .\"
  58 .\" .SE
  59 .\"     End of list of standard options for a Tk widget.
  60 .\"
  61 .\" .OP cmdName dbName dbClass
  62 .\"     Start of description of a specific option.  cmdName gives the
  63 .\"     option's name as specified in the class command, dbName gives
  64 .\"     the option's name in the option database, and dbClass gives
  65 .\"     the option's class in the option database.
  66 .\"
  67 .\" .UL arg1 arg2
  68 .\"     Print arg1 underlined, then print arg2 normally.
  69 .\"
  70 .\" .QW arg1 ?arg2?
  71 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  72 .\"
  73 .\" .PQ arg1 ?arg2?
  74 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  75 .\"     (for trailing punctuation) and then a closing parenthesis.
  76 .\"
  77 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  78 .if t .wh -1.3i ^B
  79 .nr ^l \n(.l
  80 .ad b
  81 .\"     # Start an argument description
  82 .de AP
  83 .ie !"\\$4"" .TP \\$4
  84 .el \{\
  85 .   ie !"\\$2"" .TP \\n()Cu
  86 .   el          .TP 15
  87 .\}
  88 .ta \\n()Au \\n()Bu
  89 .ie !"\\$3"" \{\
  90 \&\\$1 \\fI\\$2\\fP (\\$3)
  91 .\".b
  92 .\}
  93 .el \{\
  94 .br
  95 .ie !"\\$2"" \{\
  96 \&\\$1  \\fI\\$2\\fP
  97 .\}
  98 .el \{\
  99 \&\\fI\\$1\\fP
 100 .\}
 101 .\}
 102 ..
 103 .\"     # define tabbing values for .AP
 104 .de AS
 105 .nr )A 10n
 106 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 107 .nr )B \\n()Au+15n
 108 .\"
 109 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 110 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 111 ..
 112 .AS Tcl_Interp Tcl_CreateInterp in/out
 113 .\"     # BS - start boxed text
 114 .\"     # ^y = starting y location
 115 .\"     # ^b = 1
 116 .de BS
 117 .br
 118 .mk ^y
 119 .nr ^b 1u
 120 .if n .nf
 121 .if n .ti 0
 122 .if n \l'\\n(.lu\(ul'
 123 .if n .fi
 124 ..
 125 .\"     # BE - end boxed text (draw box now)
 126 .de BE
 127 .nf
 128 .ti 0
 129 .mk ^t
 130 .ie n \l'\\n(^lu\(ul'
 131 .el \{\
 132 .\"     Draw four-sided box normally, but don't draw top of
 133 .\"     box if the box started on an earlier page.
 134 .ie !\\n(^b-1 \{\
 135 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 136 .\}
 137 .el \}\
 138 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 139 .\}
 140 .\}
 141 .fi
 142 .br
 143 .nr ^b 0
 144 ..
 145 .\"     # VS - start vertical sidebar
 146 .\"     # ^Y = starting y location
 147 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 148 .de VS
 149 .if !"\\$2"" .br
 150 .mk ^Y
 151 .ie n 'mc \s12\(br\s0
 152 .el .nr ^v 1u
 153 ..
 154 .\"     # VE - end of vertical sidebar
 155 .de VE
 156 .ie n 'mc
 157 .el \{\
 158 .ev 2
 159 .nf
 160 .ti 0
 161 .mk ^t
 162 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 163 .sp -1
 164 .fi
 165 .ev
 166 .\}
 167 .nr ^v 0
 168 ..
 169 .\"     # Special macro to handle page bottom:  finish off current
 170 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 171 .\"     # page bottom macro.
 172 .de ^B
 173 .ev 2
 174 'ti 0
 175 'nf
 176 .mk ^t
 177 .if \\n(^b \{\
 178 .\"     Draw three-sided box if this is the box's first page,
 179 .\"     draw two sides but no top otherwise.
 180 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 181 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 182 .\}
 183 .if \\n(^v \{\
 184 .nr ^x \\n(^tu+1v-\\n(^Yu
 185 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 186 .\}
 187 .bp
 188 'fi
 189 .ev
 190 .if \\n(^b \{\
 191 .mk ^y
 192 .nr ^b 2
 193 .\}
 194 .if \\n(^v \{\
 195 .mk ^Y
 196 .\}
 197 ..
 198 .\"     # DS - begin display
 199 .de DS
 200 .RS
 201 .nf
 202 .sp
 203 ..
 204 .\"     # DE - end display
 205 .de DE
 206 .fi
 207 .RE
 208 .sp
 209 ..
 210 .\"     # SO - start of list of standard options
 211 .de SO
 212 'ie '\\$1'' .ds So \\fBoptions\\fR
 213 'el .ds So \\fB\\$1\\fR
 214 .SH "STANDARD OPTIONS"
 215 .LP
 216 .nf
 217 .ta 5.5c 11c
 218 .ft B
 219 ..
 220 .\"     # SE - end of list of standard options
 221 .de SE
 222 .fi
 223 .ft R
 224 .LP
 225 See the \\*(So manual entry for details on the standard options.
 226 ..
 227 .\"     # OP - start of full description for a single option
 228 .de OP
 229 .LP
 230 .nf
 231 .ta 4c
 232 Command-Line Name:      \\fB\\$1\\fR
 233 Database Name:  \\fB\\$2\\fR
 234 Database Class: \\fB\\$3\\fR
 235 .fi
 236 .IP
 237 ..
 238 .\"     # CS - begin code excerpt
 239 .de CS
 240 .RS
 241 .nf
 242 .ta .25i .5i .75i 1i
 243 ..
 244 .\"     # CE - end code excerpt
 245 .de CE
 246 .fi
 247 .RE
 248 ..
 249 .\"     # UL - underline word
 250 .de UL
 251 \\$1\l'|0\(ul'\\$2
 252 ..
 253 .\"     # QW - apply quotation marks to word
 254 .de QW
 255 .ie '\\*(lq'"' ``\\$1''\\$2
 256 .\"" fix emacs highlighting
 257 .el \\*(lq\\$1\\*(rq\\$2
 258 ..
 259 .\"     # PQ - apply parens and quotation marks to word
 260 .de PQ
 261 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 262 .\"" fix emacs highlighting
 263 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 264 ..
 265 .\"     # QR - quoted range
 266 .de QR
 267 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 268 .\"" fix emacs highlighting
 269 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 270 ..
 271 .\"     # MT - "empty" string
 272 .de MT
 273 .QW ""
 274 ..
 275 .BS
 276 '\" Note:  do not modify the .SH NAME line immediately below!
 277 .SH NAME
 278 vwait \- Process events until a variable is written
 279 .SH SYNOPSIS
 280 \fBvwait\fR \fIvarName\fR
 281 .BE
 282 .SH DESCRIPTION
 283 .PP
 284 This command enters the Tcl event loop to process events, blocking
 285 the application if no events are ready.  It continues processing
 286 events until some event handler sets the value of the global variable
 287 \fIvarName\fR.  Once \fIvarName\fR has been set, the \fBvwait\fR
 288 command will return as soon as the event handler that modified
 289 \fIvarName\fR completes.  The \fIvarName\fR argument is always interpreted as
 290 a variable name with respect to the global namespace, but can refer to any
 291 namespace's variables if the fully-qualified name is given.
 292 .PP
 293 In some cases the \fBvwait\fR command may not return immediately
 294 after \fIvarName\fR is set.  This happens if the event handler
 295 that sets \fIvarName\fR does not complete immediately.  For example,
 296 if an event handler sets \fIvarName\fR and then itself calls
 297 \fBvwait\fR to wait for a different variable, then it may not return
 298 for a long time.  During this time the top-level \fBvwait\fR is
 299 blocked waiting for the event handler to complete, so it cannot
 300 return either. (See the \fBNESTED VWAITS BY EXAMPLE\fR below.)
 301 .PP
 302 To be clear, \fImultiple \fBvwait\fI calls will nest and will not happen in
 303 parallel\fR.  The outermost call to \fBvwait\fR will not return until all the
 304 inner ones do.  It is recommended that code should never nest \fBvwait\fR
 305 calls (by avoiding putting them in event callbacks) but when that is not
 306 possible, care should be taken to add interlock variables to the code to
 307 prevent all reentrant calls to \fBvwait\fR that are not \fIstrictly\fR
 308 necessary. Be aware that the synchronous modes of operation of some Tcl
 309 packages (e.g.,\ \fBhttp\fR) use \fBvwait\fR internally; if using the event
 310 loop, it is best to use the asynchronous callback-based modes of operation of
 311 those packages where available.
 312 .SH EXAMPLES
 313 .PP
 314 Run the event-loop continually until some event calls \fBexit\fR.
 315 (You can use any variable not mentioned elsewhere, but the name
 316 \fIforever\fR reminds you at a glance of the intent.)
 317 .PP
 318 .CS
 319 \fBvwait\fR forever
 320 .CE
 321 .PP
 322 Wait five seconds for a connection to a server socket, otherwise
 323 close the socket and continue running the script:
 324 .PP
 325 .CS
 326 # Initialise the state
 327 after 5000 set state timeout
 328 set server [socket -server accept 12345]
 329 proc accept {args} {
 330     global state connectionInfo
 331     set state accepted
 332     set connectionInfo $args
 333 }
 334
 335 # Wait for something to happen
 336 \fBvwait\fR state
 337
 338 # Clean up events that could have happened
 339 close $server
 340 after cancel set state timeout
 341
 342 # Do something based on how the vwait finished...
 343 switch $state {
 344     timeout {
 345         puts "no connection on port 12345"
 346     }
 347     accepted {
 348        puts "connection: $connectionInfo"
 349        puts [lindex $connectionInfo 0] "Hello there!"
 350     }
 351 }
 352 .CE
 353 .PP
 354 A command that will wait for some time delay by waiting for a namespace
 355 variable to be set.  Includes an interlock to prevent nested waits.
 356 .PP
 357 .CS
 358 namespace eval example {
 359     variable v done
 360     proc wait {delay} {
 361         variable v
 362         if {$v ne "waiting"} {
 363             set v waiting
 364             after $delay [namespace code {set v done}]
 365             \fBvwait\fR [namespace which -variable v]
 366         }
 367         return $v
 368     }
 369 }
 370 .CE
 371 .PP
 372 When running inside a \fBcoroutine\fR, an alternative to using \fBvwait\fR is
 373 to \fByield\fR to an outer event loop and to get recommenced when the variable
 374 is set, or at an idle moment after that.
 375 .PP
 376 .CS
 377 coroutine task apply {{} {
 378     # simulate [after 1000]
 379     after 1000 [info coroutine]
 380     yield
 381
 382     # schedule the setting of a global variable, as normal
 383     after 2000 {set var 1}
 384
 385     # simulate [\fBvwait\fR var]
 386     proc updatedVar {task args} {
 387         after idle $task
 388         trace remove variable ::var write "updatedVar $task"
 389     }
 390     trace add variable ::var write "updatedVar [info coroutine]"
 391     yield
 392 }}
 393 .CE
 394 .SS "NESTED VWAITS BY EXAMPLE"
 395 .PP
 396 This example demonstrates what can happen when the \fBvwait\fR command is
 397 nested. The script will never finish because the waiting for the \fIa\fR
 398 variable never finishes; that \fBvwait\fR command is still waiting for a
 399 script scheduled with \fBafter\fR to complete, which just happens to be
 400 running an inner \fBvwait\fR (for \fIb\fR) even though the event that the
 401 outer \fBvwait\fR was waiting for (the setting of \fIa\fR) has occurred.
 402 .PP
 403 .CS
 404 after 500 {
 405     puts "waiting for b"
 406     \fBvwait\fR b
 407     puts "b was set"
 408 }
 409 after 1000 {
 410     puts "setting a"
 411     set a 10
 412 }
 413 puts "waiting for a"
 414 \fBvwait\fR a
 415 puts "a was set"
 416 puts "setting b"
 417 set b 42
 418 .CE
 419 .PP
 420 If you run the above code, you get this output:
 421 .PP
 422 .CS
 423 waiting for a
 424 waiting for b
 425 setting a
 426 .CE
 427 .PP
 428 The script will never print
 429 .QW "a was set"
 430 until after it has printed
 431 .QW "b was set"
 432 because of the nesting of \fBvwait\fR commands, and yet \fIb\fR will not be
 433 set until after the outer \fBvwait\fR returns, so the script has deadlocked.
 434 The only ways to avoid this are to either structure the overall program in
 435 continuation-passing style or to use \fBcoroutine\fR to make the continuations
 436 implicit. The first of these options would be written as:
 437 .PP
 438 .CS
 439 after 500 {
 440     puts "waiting for b"
 441     trace add variable b write {apply {args {
 442         global a b
 443         trace remove variable ::b write \e
 444                 [lrange [info level 0] 0 1]
 445         puts "b was set"
 446         set ::done ok
 447     }}}
 448 }
 449 after 1000 {
 450     puts "setting a"
 451     set a 10
 452 }
 453 puts "waiting for a"
 454 trace add variable a write {apply {args {
 455     global a b
 456     trace remove variable a write [lrange [info level 0] 0 1]
 457     puts "a was set"
 458     puts "setting b"
 459     set b 42
 460 }}}
 461 \fBvwait\fR done
 462 .CE
 463 .PP
 464 The second option, with \fBcoroutine\fR and some helper procedures, is done
 465 like this:
 466 .PP
 467 .CS
 468 # A coroutine-based wait-for-variable command
 469 proc waitvar globalVar {
 470     trace add variable ::$globalVar write \e
 471             [list apply {{v c args} {
 472         trace remove variable $v write \e
 473                 [lrange [info level 0] 0 3]
 474         after 0 $c
 475     }} ::$globalVar [info coroutine]]
 476     yield
 477 }
 478 # A coroutine-based wait-for-some-time command
 479 proc waittime ms {
 480     after $ms [info coroutine]
 481     yield
 482 }
 483
 484 coroutine task-1 eval {
 485     puts "waiting for a"
 486     waitvar a
 487     puts "a was set"
 488     puts "setting b"
 489     set b 42
 490 }
 491 coroutine task-2 eval {
 492     waittime 500
 493     puts "waiting for b"
 494     waitvar b
 495     puts "b was set"
 496     set done ok
 497 }
 498 coroutine task-3 eval {
 499     waittime 1000
 500     puts "setting a"
 501     set a 10
 502 }
 503 \fBvwait\fR done
 504 .CE
 505 .SH "SEE ALSO"
 506 global(n), update(n)
 507 .SH KEYWORDS
 508 asynchronous I/O, event, variable, wait
 509 '\" Local Variables:
 510 '\" mode: nroff
 511 '\" fill-column: 78
 512 '\" End: