summaryrefslogtreecommitdiffstats
path: root/doc/CrtFileHdlr.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/CrtFileHdlr.3')
-rw-r--r--doc/CrtFileHdlr.313
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/CrtFileHdlr.3 b/doc/CrtFileHdlr.3
index f1b8df7..e35020c 100644
--- a/doc/CrtFileHdlr.3
+++ b/doc/CrtFileHdlr.3
@@ -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.
-'\"
+'\"
.TH Tcl_CreateFileHandler 3 8.0 Tcl "Tcl Library Procedures"
.so man.macros
.BS
@@ -32,6 +32,7 @@ by \fIfile\fR meets the conditions specified by \fImask\fR.
.AP ClientData clientData in
Arbitrary one-word value to pass to \fIproc\fR.
.BE
+
.SH DESCRIPTION
.PP
\fBTcl_CreateFileHandler\fR arranges for \fIproc\fR to be
@@ -48,13 +49,11 @@ as \fBvwait\fR.
.PP
\fIProc\fR should have arguments and result that match the
type \fBTcl_FileProc\fR:
-.PP
.CS
-typedef void \fBTcl_FileProc\fR(
+typedef void Tcl_FileProc(
ClientData \fIclientData\fR,
int \fImask\fR);
.CE
-.PP
The \fIclientData\fR parameter to \fIproc\fR is a copy
of the \fIclientData\fR
argument given to \fBTcl_CreateFileHandler\fR when the callback
@@ -65,6 +64,7 @@ of the requested conditions actually exists for the file; it
will contain a subset of the bits in the \fImask\fR argument
to \fBTcl_CreateFileHandler\fR.
.PP
+.PP
There may exist only one handler for a given file at a given time.
If \fBTcl_CreateFileHandler\fR is called when a handler already
exists for \fIfd\fR, then the new callback replaces the information
@@ -84,8 +84,7 @@ complete the application will not be able to service other events. Use
blocking or nonblocking mode as required.
.PP
Note that these interfaces are only supported by the Unix
-implementation of the Tcl notifier.
-.SH "SEE ALSO"
-fileevent(n), Tcl_CreateTimerHandler(3), Tcl_DoWhenIdle(3)
+implementation of the Tcl notifier.
+
.SH KEYWORDS
callback, file, handler