util/X86LINUX64/man/man3/Tcl_AsyncInvoke.3

   1 '\"
   2 '\" Copyright (c) 1989-1993 The Regents of the University of California.
   3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
   4 '\"
   5 '\" See the file "license.terms" for information on usage and redistribution
   6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   7 '\"
   8 .TH Tcl_AsyncCreate 3 7.0 Tcl "Tcl Library Procedures"
   9 .\" The -*- nroff -*- definitions below are for supplemental macros used
  10 .\" in Tcl/Tk manual entries.
  11 .\"
  12 .\" .AP type name in/out ?indent?
  13 .\"     Start paragraph describing an argument to a library procedure.
  14 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  15 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  16 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  17 .\"     needed;  use .AS below instead)
  18 .\"
  19 .\" .AS ?type? ?name?
  20 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  21 .\"     name are examples of largest possible arguments that will be passed
  22 .\"     to .AP later.  If args are omitted, default tab stops are used.
  23 .\"
  24 .\" .BS
  25 .\"     Start box enclosure.  From here until next .BE, everything will be
  26 .\"     enclosed in one large box.
  27 .\"
  28 .\" .BE
  29 .\"     End of box enclosure.
  30 .\"
  31 .\" .CS
  32 .\"     Begin code excerpt.
  33 .\"
  34 .\" .CE
  35 .\"     End code excerpt.
  36 .\"
  37 .\" .VS ?version? ?br?
  38 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  39 .\"     of man pages.  The first argument is ignored and used for recording
  40 .\"     the version when the .VS was added, so that the sidebars can be
  41 .\"     found and removed when they reach a certain age.  If another argument
  42 .\"     is present, then a line break is forced before starting the sidebar.
  43 .\"
  44 .\" .VE
  45 .\"     End of vertical sidebar.
  46 .\"
  47 .\" .DS
  48 .\"     Begin an indented unfilled display.
  49 .\"
  50 .\" .DE
  51 .\"     End of indented unfilled display.
  52 .\"
  53 .\" .SO ?manpage?
  54 .\"     Start of list of standard options for a Tk widget. The manpage
  55 .\"     argument defines where to look up the standard options; if
  56 .\"     omitted, defaults to "options". The options follow on successive
  57 .\"     lines, in three columns separated by tabs.
  58 .\"
  59 .\" .SE
  60 .\"     End of list of standard options for a Tk widget.
  61 .\"
  62 .\" .OP cmdName dbName dbClass
  63 .\"     Start of description of a specific option.  cmdName gives the
  64 .\"     option's name as specified in the class command, dbName gives
  65 .\"     the option's name in the option database, and dbClass gives
  66 .\"     the option's class in the option database.
  67 .\"
  68 .\" .UL arg1 arg2
  69 .\"     Print arg1 underlined, then print arg2 normally.
  70 .\"
  71 .\" .QW arg1 ?arg2?
  72 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  73 .\"
  74 .\" .PQ arg1 ?arg2?
  75 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  76 .\"     (for trailing punctuation) and then a closing parenthesis.
  77 .\"
  78 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  79 .if t .wh -1.3i ^B
  80 .nr ^l \n(.l
  81 .ad b
  82 .\"     # Start an argument description
  83 .de AP
  84 .ie !"\\$4"" .TP \\$4
  85 .el \{\
  86 .   ie !"\\$2"" .TP \\n()Cu
  87 .   el          .TP 15
  88 .\}
  89 .ta \\n()Au \\n()Bu
  90 .ie !"\\$3"" \{\
  91 \&\\$1 \\fI\\$2\\fP (\\$3)
  92 .\".b
  93 .\}
  94 .el \{\
  95 .br
  96 .ie !"\\$2"" \{\
  97 \&\\$1  \\fI\\$2\\fP
  98 .\}
  99 .el \{\
 100 \&\\fI\\$1\\fP
 101 .\}
 102 .\}
 103 ..
 104 .\"     # define tabbing values for .AP
 105 .de AS
 106 .nr )A 10n
 107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 108 .nr )B \\n()Au+15n
 109 .\"
 110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 112 ..
 113 .AS Tcl_Interp Tcl_CreateInterp in/out
 114 .\"     # BS - start boxed text
 115 .\"     # ^y = starting y location
 116 .\"     # ^b = 1
 117 .de BS
 118 .br
 119 .mk ^y
 120 .nr ^b 1u
 121 .if n .nf
 122 .if n .ti 0
 123 .if n \l'\\n(.lu\(ul'
 124 .if n .fi
 125 ..
 126 .\"     # BE - end boxed text (draw box now)
 127 .de BE
 128 .nf
 129 .ti 0
 130 .mk ^t
 131 .ie n \l'\\n(^lu\(ul'
 132 .el \{\
 133 .\"     Draw four-sided box normally, but don't draw top of
 134 .\"     box if the box started on an earlier page.
 135 .ie !\\n(^b-1 \{\
 136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 137 .\}
 138 .el \}\
 139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 140 .\}
 141 .\}
 142 .fi
 143 .br
 144 .nr ^b 0
 145 ..
 146 .\"     # VS - start vertical sidebar
 147 .\"     # ^Y = starting y location
 148 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 149 .de VS
 150 .if !"\\$2"" .br
 151 .mk ^Y
 152 .ie n 'mc \s12\(br\s0
 153 .el .nr ^v 1u
 154 ..
 155 .\"     # VE - end of vertical sidebar
 156 .de VE
 157 .ie n 'mc
 158 .el \{\
 159 .ev 2
 160 .nf
 161 .ti 0
 162 .mk ^t
 163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 164 .sp -1
 165 .fi
 166 .ev
 167 .\}
 168 .nr ^v 0
 169 ..
 170 .\"     # Special macro to handle page bottom:  finish off current
 171 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 172 .\"     # page bottom macro.
 173 .de ^B
 174 .ev 2
 175 'ti 0
 176 'nf
 177 .mk ^t
 178 .if \\n(^b \{\
 179 .\"     Draw three-sided box if this is the box's first page,
 180 .\"     draw two sides but no top otherwise.
 181 .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
 182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 183 .\}
 184 .if \\n(^v \{\
 185 .nr ^x \\n(^tu+1v-\\n(^Yu
 186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 187 .\}
 188 .bp
 189 'fi
 190 .ev
 191 .if \\n(^b \{\
 192 .mk ^y
 193 .nr ^b 2
 194 .\}
 195 .if \\n(^v \{\
 196 .mk ^Y
 197 .\}
 198 ..
 199 .\"     # DS - begin display
 200 .de DS
 201 .RS
 202 .nf
 203 .sp
 204 ..
 205 .\"     # DE - end display
 206 .de DE
 207 .fi
 208 .RE
 209 .sp
 210 ..
 211 .\"     # SO - start of list of standard options
 212 .de SO
 213 'ie '\\$1'' .ds So \\fBoptions\\fR
 214 'el .ds So \\fB\\$1\\fR
 215 .SH "STANDARD OPTIONS"
 216 .LP
 217 .nf
 218 .ta 5.5c 11c
 219 .ft B
 220 ..
 221 .\"     # SE - end of list of standard options
 222 .de SE
 223 .fi
 224 .ft R
 225 .LP
 226 See the \\*(So manual entry for details on the standard options.
 227 ..
 228 .\"     # OP - start of full description for a single option
 229 .de OP
 230 .LP
 231 .nf
 232 .ta 4c
 233 Command-Line Name:      \\fB\\$1\\fR
 234 Database Name:  \\fB\\$2\\fR
 235 Database Class: \\fB\\$3\\fR
 236 .fi
 237 .IP
 238 ..
 239 .\"     # CS - begin code excerpt
 240 .de CS
 241 .RS
 242 .nf
 243 .ta .25i .5i .75i 1i
 244 ..
 245 .\"     # CE - end code excerpt
 246 .de CE
 247 .fi
 248 .RE
 249 ..
 250 .\"     # UL - underline word
 251 .de UL
 252 \\$1\l'|0\(ul'\\$2
 253 ..
 254 .\"     # QW - apply quotation marks to word
 255 .de QW
 256 .ie '\\*(lq'"' ``\\$1''\\$2
 257 .\"" fix emacs highlighting
 258 .el \\*(lq\\$1\\*(rq\\$2
 259 ..
 260 .\"     # PQ - apply parens and quotation marks to word
 261 .de PQ
 262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 263 .\"" fix emacs highlighting
 264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 265 ..
 266 .\"     # QR - quoted range
 267 .de QR
 268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 269 .\"" fix emacs highlighting
 270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 271 ..
 272 .\"     # MT - "empty" string
 273 .de MT
 274 .QW ""
 275 ..
 276 .BS
 277 .SH NAME
 278 Tcl_AsyncCreate, Tcl_AsyncMark, Tcl_AsyncInvoke, Tcl_AsyncDelete, Tcl_AsyncReady \- handle asynchronous events
 279 .SH SYNOPSIS
 280 .nf
 281 \fB#include <tcl.h>\fR
 282 .sp
 283 Tcl_AsyncHandler
 284 \fBTcl_AsyncCreate\fR(\fIproc, clientData\fR)
 285 .sp
 286 \fBTcl_AsyncMark\fR(\fIasync\fR)
 287 .sp
 288 int
 289 \fBTcl_AsyncInvoke\fR(\fIinterp, code\fR)
 290 .sp
 291 \fBTcl_AsyncDelete\fR(\fIasync\fR)
 292 .sp
 293 int
 294 \fBTcl_AsyncReady\fR()
 295 .SH ARGUMENTS
 296 .AS Tcl_AsyncHandler clientData
 297 .AP Tcl_AsyncProc *proc in
 298 Procedure to invoke to handle an asynchronous event.
 299 .AP ClientData clientData in
 300 One-word value to pass to \fIproc\fR.
 301 .AP Tcl_AsyncHandler async in
 302 Token for asynchronous event handler.
 303 .AP Tcl_Interp *interp in
 304 Tcl interpreter in which command was being evaluated when handler was
 305 invoked, or NULL if handler was invoked when there was no interpreter
 306 active.
 307 .AP int code in
 308 Completion code from command that just completed in \fIinterp\fR,
 309 or 0 if \fIinterp\fR is NULL.
 310 .BE
 311
 312 .SH DESCRIPTION
 313 .PP
 314 These procedures provide a safe mechanism for dealing with
 315 asynchronous events such as signals.
 316 If an event such as a signal occurs while a Tcl script is being
 317 evaluated then it is not safe to take any substantive action to
 318 process the event.
 319 For example, it is not safe to evaluate a Tcl script since the
 320 interpreter may already be in the middle of evaluating a script;
 321 it may not even be safe to allocate memory, since a memory
 322 allocation could have been in progress when the event occurred.
 323 The only safe approach is to set a flag indicating that the event
 324 occurred, then handle the event later when the world has returned
 325 to a clean state, such as after the current Tcl command completes.
 326 .PP
 327 \fBTcl_AsyncCreate\fR, \fBTcl_AsyncDelete\fR, and \fBTcl_AsyncReady\fR
 328 are thread sensitive.  They access and/or set a thread-specific data
 329 structure in the event of a core built with \fI\-\-enable\-threads\fR.  The token
 330 created by \fBTcl_AsyncCreate\fR contains the needed thread information it
 331 was called from so that calling \fBTcl_AsyncMark\fR(\fItoken\fR) will only yield
 332 the origin thread into the asynchronous handler.
 333 .PP
 334 \fBTcl_AsyncCreate\fR creates an asynchronous handler and returns
 335 a token for it.
 336 The asynchronous handler must be created before
 337 any occurrences of the asynchronous event that it is intended
 338 to handle (it is not safe to create a handler at the time of
 339 an event).
 340 When an asynchronous event occurs the code that detects the event
 341 (such as a signal handler) should call \fBTcl_AsyncMark\fR with the
 342 token for the handler.
 343 \fBTcl_AsyncMark\fR will mark the handler as ready to execute, but it
 344 will not invoke the handler immediately.
 345 Tcl will call the \fIproc\fR associated with the handler later, when
 346 the world is in a safe state, and \fIproc\fR can then carry out
 347 the actions associated with the asynchronous event.
 348 \fIProc\fR should have arguments and result that match the
 349 type \fBTcl_AsyncProc\fR:
 350 .PP
 351 .CS
 352 typedef int \fBTcl_AsyncProc\fR(
 353         ClientData \fIclientData\fR,
 354         Tcl_Interp *\fIinterp\fR,
 355         int \fIcode\fR);
 356 .CE
 357 .PP
 358 The \fIclientData\fR will be the same as the \fIclientData\fR
 359 argument passed to \fBTcl_AsyncCreate\fR when the handler was
 360 created.
 361 If \fIproc\fR is invoked just after a command has completed
 362 execution in an interpreter, then \fIinterp\fR will identify
 363 the interpreter in which the command was evaluated and
 364 \fIcode\fR will be the completion code returned by that
 365 command.
 366 The command's result will be present in the interpreter's result.
 367 When \fIproc\fR returns, whatever it leaves in the interpreter's result
 368 will be returned as the result of the command and the integer
 369 value returned by \fIproc\fR will be used as the new completion
 370 code for the command.
 371 .PP
 372 It is also possible for \fIproc\fR to be invoked when no interpreter
 373 is active.
 374 This can happen, for example, if an asynchronous event occurs while
 375 the application is waiting for interactive input or an X event.
 376 In this case \fIinterp\fR will be NULL and \fIcode\fR will be
 377 0, and the return value from \fIproc\fR will be ignored.
 378 .PP
 379 The procedure \fBTcl_AsyncInvoke\fR is called to invoke all of the
 380 handlers that are ready.
 381 The procedure \fBTcl_AsyncReady\fR will return non-zero whenever any
 382 asynchronous handlers are ready;  it can be checked to avoid calls
 383 to \fBTcl_AsyncInvoke\fR when there are no ready handlers.
 384 Tcl calls \fBTcl_AsyncReady\fR after each command is evaluated
 385 and calls \fBTcl_AsyncInvoke\fR if needed.
 386 Applications may also call \fBTcl_AsyncInvoke\fR at interesting
 387 times for that application.
 388 For example, Tcl's event handler calls \fBTcl_AsyncReady\fR
 389 after each event and calls \fBTcl_AsyncInvoke\fR if needed.
 390 The \fIinterp\fR and \fIcode\fR arguments to \fBTcl_AsyncInvoke\fR
 391 have the same meaning as for \fIproc\fR:  they identify the active
 392 interpreter, if any, and the completion code from the command
 393 that just completed.
 394 .PP
 395 \fBTcl_AsyncDelete\fR removes an asynchronous handler so that
 396 its \fIproc\fR will never be invoked again.
 397 A handler can be deleted even when ready, and it will still
 398 not be invoked.
 399 .PP
 400 If multiple handlers become active at the same time, the
 401 handlers are invoked in the order they were created (oldest
 402 handler first).
 403 The \fIcode\fR and the interpreter's result for later handlers
 404 reflect the values returned by earlier handlers, so that
 405 the most recently created handler has last say about
 406 the interpreter's result and completion code.
 407 If new handlers become ready while handlers are executing,
 408 \fBTcl_AsyncInvoke\fR will invoke them all;  at each point it
 409 invokes the highest-priority (oldest) ready handler, repeating
 410 this over and over until there are no longer any ready handlers.
 411 .SH WARNING
 412 .PP
 413 It is almost always a bad idea for an asynchronous event
 414 handler to modify the interpreter's result or return a code different
 415 from its \fIcode\fR argument.
 416 This sort of behavior can disrupt the execution of scripts in
 417 subtle ways and result in bugs that are extremely difficult
 418 to track down.
 419 If an asynchronous event handler needs to evaluate Tcl scripts
 420 then it should first save the interpreter's state by calling
 421 \fBTcl_SaveInterpState\fR, passing in the \fIcode\fR argument.
 422 When the asynchronous handler is finished it should restore
 423 the interpreter's state by calling \fBTcl_RestoreInterpState\fR,
 424 and then returning the \fIcode\fR argument.
 425
 426 .SH KEYWORDS
 427 asynchronous event, handler, signal, Tcl_SaveInterpState, thread