diff options
Diffstat (limited to 'doc/Async.3')
| -rw-r--r-- | doc/Async.3 | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/Async.3 b/doc/Async.3 index 4be3aa6..347ba3d 100644 --- a/doc/Async.3 +++ b/doc/Async.3 @@ -4,11 +4,9 @@ '\" '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. -'\" -'\" RCS: @(#) $Id: Async.3,v 1.9 2005/05/10 18:33:54 kennykb Exp $ -'\" -.so man.macros +'\" .TH Tcl_AsyncCreate 3 7.0 Tcl "Tcl Library Procedures" +.so man.macros .BS .SH NAME Tcl_AsyncCreate, Tcl_AsyncMark, Tcl_AsyncInvoke, Tcl_AsyncDelete, Tcl_AsyncReady \- handle asynchronous events @@ -50,9 +48,9 @@ or 0 if \fIinterp\fR is NULL. These procedures provide a safe mechanism for dealing with asynchronous events such as signals. If an event such as a signal occurs while a Tcl script is being -evaluated then it isn't safe to take any substantive action to +evaluated then it is not safe to take any substantive action to process the event. -For example, it isn't safe to evaluate a Tcl script since the +For example, it is not safe to evaluate a Tcl script since the interpreter may already be in the middle of evaluating a script; it may not even be safe to allocate memory, since a memory allocation could have been in progress when the event occurred. @@ -83,12 +81,14 @@ the world is in a safe state, and \fIproc\fR can then carry out the actions associated with the asynchronous event. \fIProc\fR should have arguments and result that match the type \fBTcl_AsyncProc\fR: +.PP .CS -typedef int Tcl_AsyncProc( +typedef int \fBTcl_AsyncProc\fR( ClientData \fIclientData\fR, Tcl_Interp *\fIinterp\fR, int \fIcode\fR); .CE +.PP The \fIclientData\fR will be the same as the \fIclientData\fR argument passed to \fBTcl_AsyncCreate\fR when the handler was created. @@ -142,7 +142,6 @@ If new handlers become ready while handlers are executing, \fBTcl_AsyncInvoke\fR will invoke them all; at each point it invokes the highest-priority (oldest) ready handler, repeating this over and over until there are no longer any ready handlers. - .SH WARNING .PP It is almost always a bad idea for an asynchronous event @@ -159,4 +158,4 @@ the interpreter's state by calling \fBTcl_RestoreInterpState\fR, and then returning the \fIcode\fR argument. .SH KEYWORDS -asynchronous event, handler, signal, Tcl_SaveInterpState +asynchronous event, handler, signal, Tcl_SaveInterpState, thread |