通讯编程

开发平台：
Visual C++

Async.3：源码内容
							'"
'" Copyright (c) 1989-1993 The Regents of the University of California.
'" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'"
'" 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.5.18.1 2004/12/09 09:24:54 dkf Exp $
'" 
.so man.macros
.TH Tcl_AsyncCreate 3 7.0 Tcl "Tcl Library Procedures"
.BS
.SH NAME
Tcl_AsyncCreate, Tcl_AsyncMark, Tcl_AsyncInvoke, Tcl_AsyncDelete, Tcl_AsyncReady - handle asynchronous events
.SH SYNOPSIS
.nf
fB#include <tcl.h>fR
.sp
Tcl_AsyncHandler
fBTcl_AsyncCreatefR(fIproc, clientDatafR)
.sp
fBTcl_AsyncMarkfR(fIasyncfR)
.sp
int
fBTcl_AsyncInvokefR(fIinterp, codefR)
.sp
fBTcl_AsyncDeletefR(fIasyncfR)
.sp
int
fBTcl_AsyncReadyfR()
.SH ARGUMENTS
.AS Tcl_AsyncHandler clientData
.AP Tcl_AsyncProc *proc in
Procedure to invoke to handle an asynchronous event.
.AP ClientData clientData in
One-word value to pass to fIprocfR.
.AP Tcl_AsyncHandler async in
Token for asynchronous event handler.
.AP Tcl_Interp *interp in
Tcl interpreter in which command was being evaluated when handler was
invoked, or NULL if handler was invoked when there was no interpreter
active.
.AP int code in
Completion code from command that just completed in fIinterpfR,
or 0 if fIinterpfR is NULL.
.BE
.SH DESCRIPTION
.PP
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
process the event.
For example, it isn't 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.
The only safe approach is to set a flag indicating that the event
occurred, then handle the event later when the world has returned
to a clean state, such as after the current Tcl command completes.
.PP
fBTcl_AsyncCreatefR, fBTcl_AsyncDeletefR, and fBTcl_AsyncReadyfR
are thread sensitive.  They access and/or set a thread-specific data
structure in the event of a core built with fI--enable-threadsfR.  The token
created by fBTcl_AsyncCreatefR contains the needed thread information it
was called from so that calling fBTcl_AsyncMarkfR(fItokenfR) will only yield
the origin thread into the asynchronous handler.
.PP
fBTcl_AsyncCreatefR creates an asynchronous handler and returns
a token for it.
The asynchronous handler must be created before
any occurrences of the asynchronous event that it is intended
to handle (it is not safe to create a handler at the time of
an event).
When an asynchronous event occurs the code that detects the event
(such as a signal handler) should call fBTcl_AsyncMarkfR with the
token for the handler.
fBTcl_AsyncMarkfR will mark the handler as ready to execute, but it
will not invoke the handler immediately.
Tcl will call the fIprocfR associated with the handler later, when
the world is in a safe state, and fIprocfR can then carry out
the actions associated with the asynchronous event.
fIProcfR should have arguments and result that match the
type fBTcl_AsyncProcfR:
.CS
typedef int Tcl_AsyncProc(
        ClientData fIclientDatafR,
        Tcl_Interp *fIinterpfR,
        int fIcodefR);
.CE
The fIclientDatafR will be the same as the fIclientDatafR
argument passed to fBTcl_AsyncCreatefR when the handler was
created.
If fIprocfR is invoked just after a command has completed
execution in an interpreter, then fIinterpfR will identify
the interpreter in which the command was evaluated and
fIcodefR will be the completion code returned by that
command.
The command's result will be present in the interpreter's result.
When fIprocfR returns, whatever it leaves in the interpreter's result
will be returned as the result of the command and the integer
value returned by fIprocfR will be used as the new completion
code for the command.
.PP
It is also possible for fIprocfR to be invoked when no interpreter
is active.
This can happen, for example, if an asynchronous event occurs while
the application is waiting for interactive input or an X event.
In this case fIinterpfR will be NULL and fIcodefR will be
0, and the return value from fIprocfR will be ignored.
.PP
The procedure fBTcl_AsyncInvokefR is called to invoke all of the
handlers that are ready.
The procedure fBTcl_AsyncReadyfR will return non-zero whenever any
asynchronous handlers are ready;  it can be checked to avoid calls
to fBTcl_AsyncInvokefR when there are no ready handlers.
Tcl calls fBTcl_AsyncReadyfR after each command is evaluated
and calls fBTcl_AsyncInvokefR if needed.
Applications may also call fBTcl_AsyncInvokefR at interesting
times for that application.
For example, Tcl's event handler calls fBTcl_AsyncReadyfR
after each event and calls fBTcl_AsyncInvokefR if needed.
The fIinterpfR and fIcodefR arguments to fBTcl_AsyncInvokefR
have the same meaning as for fIprocfR:  they identify the active
interpreter, if any, and the completion code from the command
that just completed.
.PP
fBTcl_AsyncDeletefR removes an asynchronous handler so that
its fIprocfR will never be invoked again.
A handler can be deleted even when ready, and it will still
not be invoked.
.PP
If multiple handlers become active at the same time, the
handlers are invoked in the order they were created (oldest
handler first).
The fIcodefR and the interpreter's result for later handlers
reflect the values returned by earlier handlers, so that
the most recently created handler has last say about
the interpreter's result and completion code.
If new handlers become ready while handlers are executing,
fBTcl_AsyncInvokefR 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
handler to modify the interpreter's result or return a code different
from its fIcodefR argument.
This sort of behavior can disrupt the execution of scripts in
subtle ways and result in bugs that are extremely difficult
to track down.
If an asynchronous event handler needs to evaluate Tcl scripts
then it should first save the interpreter's result plus the values
of the variables fBerrorInfofR and fBerrorCodefR (this can
be done, for example, by storing them in dynamic strings).
When the asynchronous handler is finished it should restore
the interpreter's result, fBerrorInfofR, and fBerrorCodefR,
and return the fIcodefR argument.
.SH KEYWORDS
asynchronous event, handler, signal

						