Tcl_CreateFileHandler (3)
associate procedure callbacks with files or devices (Unix only)
SYNOPSIS
#include <tcl.h>
Tcl_CreateFileHandler(fd, mask, proc, clientData)
Tcl_DeleteFileHandler(fd)
ARGUMENTS
Tcl_FileProc clientData
int fd in
Unix file descriptor for an open file or device.
int mask in
Conditions under which proc should be called:
OR-ed combination of TCL_READABLE, TCL_WRITABLE,
and TCL_EXCEPTION. May be set to 0 to temporarily disable
a handler.
Tcl_FileProc *proc in
Procedure to invoke whenever the file or device indicated
by file meets the conditions specified by mask.
ClientData clientData in
Arbitrary one-word value to pass to proc.
DESCRIPTION
Tcl_CreateFileHandler arranges for proc to be
invoked in the future whenever I/O becomes possible on a file
or an exceptional condition exists for the file. The file
is indicated by fd, and the conditions of interest
are indicated by mask. For example, if mask
is TCL_READABLE, proc will be called when
the file is readable.
The callback to proc is made by Tcl_DoOneEvent, so
Tcl_CreateFileHandler is only useful in programs that dispatch
events through Tcl_DoOneEvent or through Tcl commands such
as vwait.
Proc should have arguments and result that match the
type Tcl_FileProc:
typedef void Tcl_FileProc(
ClientData clientData,
int mask);
The clientData parameter to proc is a copy
of the clientData
argument given to Tcl_CreateFileHandler when the callback
was created. Typically, clientData points to a data
structure containing application-specific information about
the file. Mask is an integer mask indicating which
of the requested conditions actually exists for the file; it
will contain a subset of the bits in the mask argument
to Tcl_CreateFileHandler.
There may exist only one handler for a given file at a given time.
If Tcl_CreateFileHandler is called when a handler already
exists for fd, then the new callback replaces the information
that was previously recorded.
Tcl_DeleteFileHandler may be called to delete the
file handler for fd; if no handler exists for the
file given by fd then the procedure has no effect.
The purpose of file handlers is to enable an application to respond to
events while waiting for files to become ready for I/O. For this to work
correctly, the application may need to use non-blocking I/O operations on
the files for which handlers are declared. Otherwise the application may
block if it reads or writes too much data; while waiting for the I/O to
complete the application won't be able to service other events. Use
Tcl_SetChannelOption with -blocking to set the channel into
blocking or nonblocking mode as required.
Note that these interfaces are only supported by the Unix
implementation of the Tcl notifier.
KEYWORDS
callback, file, handler
'\"
'\" 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: Hash.3,v 1.2 1998/09/14 18:39:49 stanton Exp $
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.2 1998/09/14 18:39:54 stanton Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|
