Seth Woolley's Man Viewer

Tcl_CreateFileHandler(3) - Tcl_CreateFileHandler, Tcl_DeleteFileHandler - associate procedure callbacks with files or devices (Unix only) - man 3 Tcl_CreateFileHandler

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

Tcl_CreateFileHandler(3)    Tcl Library Procedures    Tcl_CreateFileHandler(3)



______________________________________________________________________________

NAME
       Tcl_CreateFileHandler,   Tcl_DeleteFileHandler  -  associate  procedure
       callbacks with files or devices (Unix only)

SYNOPSIS
       #include <tcl.h>

       Tcl_CreateFileHandler(fd, mask, proc(5,n), clientData)                       |

       Tcl_DeleteFileHandler(fd)                                               |

ARGUMENTS
       int            fd           (in(1,8))                                        ||
                                             Unix  file(1,n) descriptor for an open(2,3,n) |
                                             file(1,n) or device.

       int            mask         (in(1,8))      Conditions   under   which   proc(5,n)
                                             should  be called: OR-ed combina-
                                             tion       of       TCL_READABLE,
                                             TCL_WRITABLE,  and TCL_EXCEPTION.
                                             May be set(7,n,1 builtins) to  0  to  temporarily
                                             disable a handler.

       Tcl_FileProc   *proc(5,n)        (in(1,8))      Procedure  to invoke whenever the
                                             file(1,n) or device indicated by  file(1,n)
                                             meets the conditions specified by
                                             mask.

       ClientData     clientData   (in(1,8))      Arbitrary one-word value to  pass
                                             to proc(5,n).
_________________________________________________________________


DESCRIPTION
       Tcl_CreateFileHandler  arranges  for  proc(5,n)  to be invoked in(1,8) the future |
       whenever I/O becomes possible on a file(1,n)  or  an  exceptional  condition |
       exists  for  the file.  The file(1,n) is indicated by fd, and the conditions |
       of interest are indicated by mask.  For example, if(3,n) mask  is  TCL_READ-
       ABLE,  proc(5,n)  will be called when the file(1,n) is readable.  The callback to
       proc(5,n) is made by Tcl_DoOneEvent, so Tcl_CreateFileHandler is only useful
       in(1,8)  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(5,n) is a copy of the clientData argument
       given to Tcl_CreateFileHandler when the callback  was  created.   Typi-
       cally,  clientData  points  to a data structure containing application-
       specific information about the file.  Mask is an integer mask  indicat-
       ing which of the requested conditions actually exists for the file(1,n);  it
       will contain a subset of the bits in(1,8) the mask argument  to  Tcl_Create-
       FileHandler.


       There  may exist only one handler for a given file(1,n) 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(1,n) handler for  fd;
       if(3,n) no handler exists for the file(1,n) given by fd then the procedure has no
       effect.

       The purpose of file(1,n) 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 opera-
       tions  on  the  files  for  which handlers are declared.  Otherwise the
       application may block if(3,n) it reads or writes too much data; while  wait-
       ing  for  the  I/O to complete the application won't be able to service
       other events. Use Tcl_SetChannelOption with -blocking to set(7,n,1 builtins) the  chan-
       nel into blocking or nonblocking mode as required.

       Note  that  these interfaces are only supported by the Unix implementa- |
       tion of the Tcl notifier.


KEYWORDS
       callback, file(1,n), handler



Tcl                                   8.0             Tcl_CreateFileHandler(3)

References for this manual (incoming links)