.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "fileevent 3"
.TH fileevent 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Tk::fileevent \- Execute a callback when a filehandle becomes readable or writable
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fR\f(CI$widget\fR\fI\fR\->\fBfileevent\fR(\fIfileHandle\fR,\fBreadable\fR?,\fIcallback\fR?)
.PP
\&\fR\f(CI$widget\fR\fI\fR\->\fBfileevent\fR(\fIfileHandle\fR,\fBwritable\fR?,\fIcallback\fR?)
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This command is used to create \fIfile event handlers\fR.  A file event
handler is a binding between a filehandle and a callback, such that the callback
is evaluated whenever the filehandle becomes readable or writable.  File event
handlers are most commonly used to allow data to be received from another
process on an event-driven basis, so that the receiver can continue to
interact with the user while waiting for the data to arrive.  If an
application invokes \f(CW\*(C`<>\*(C'\fR, \f(CW\*(C`sysread\*(C'\fR or \f(CW\*(C`read\*(C'\fR on a blocking filehandle when
there is no input data available, the process will block; until the input
data arrives, it will not be able to service other events, so it will
appear to the user to ``freeze up''.  With \fBfileevent\fR, the process can
tell when data is present and only invoke \fBgets\fR or \fBread\fR when
they won't block.
.PP
The \fIfileHandle\fR argument to \fBfileevent\fR refers to an open filehandle,
such as the return value from a previous \fBopen\fR or \fBsocket\fR
command.
If the \fIcallback\fR argument is specified, then \fBfileevent\fR
creates a new event handler:  \fIcallback\fR will be evaluated
whenever the filehandle becomes readable or writable (depending on the
argument to \fBfileevent\fR).
In this case \fBfileevent\fR returns an empty string.
The \fBreadable\fR and \fBwritable\fR event handlers for a file
are independent, and may be created and deleted separately.
However, there may be at most one \fBreadable\fR and one \fBwritable\fR
handler for a file at a given time in a given interpreter.
If \fBfileevent\fR is called when the specified handler already
exists in the invoking interpreter, the new callback replaces the old one.
.PP
If the \fIcallback\fR argument is not specified, \fBfileevent\fR
returns the current callback for \fIfileHandle\fR, or an empty string
if there is none.
If the \fIcallback\fR argument is specified as an empty string
then the event handler is deleted, so that no callback will be invoked.
A file event handler is also deleted automatically whenever
its filehandle is closed or its interpreter is deleted.
.PP
A filehandle is considered to be readable if there is unread data
available on the underlying device.
A filehandle is also considered to be readable if an end of file or
error condition is present on the underlying file or device.
It is important for \fIcallback\fR to check for these conditions
and handle them appropriately;  for example, if there is no special
check for end of file, an infinite loop may occur where \fIcallback\fR
reads no data, returns, and is immediately invoked again.
.PP
A filehandle is considered to be writable if at least one byte of data
can be written to the underlying file or device without blocking,
or if an error condition is present on the underlying file or device.
.PP
Event-driven I/O works best for filehandles that have been
placed into nonblocking mode.
In blocking mode, a \f(CW\*(C`print\*(C'\fR command may block if you give it
more data than the underlying file or device can accept, and a
\&\f(CW\*(C`<>\*(C'\fR, \f(CW\*(C`sysread\*(C'\fR or \f(CW\*(C`read\*(C'\fR command will block if you attempt to read
more data than is ready;  no events will be processed while the
commands block.
In nonblocking mode \f(CW\*(C`print\*(C'\fR, \f(CW\*(C`<>\*(C'\fR, \f(CW\*(C`sysread\*(C'\fR and \f(CW\*(C`read\*(C'\fR never block.
See the documentation for the individual commands for information
on how they handle blocking and nonblocking filehandles.
.PP
The callback for a file event is executed in the context of \fR\f(CI$widget\fR\fI\fR
with which \fBfileevent\fR was invoked.
If an error occurs while executing the callback then the
Tk::Error mechanism is used to report the error.
In addition, the file event handler is deleted if it ever returns
an error;  this is done in order to prevent infinite loops due to
buggy handlers.
.SH BUGS
.IX Header "BUGS"
On windows platforms \fBfileevent\fR is limited in the types of filehandles
that behave correctly. Making filehandles non-blocking is only implemented
on a subset of UNIX platforms (see Tk::IO).
.SH CREDITS
.IX Header "CREDITS"
\&\fBfileevent\fR is based on the \fBaddinput\fR command created
by Mark Diekhans.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Tk::IO
Tk::callbacks
.SH KEYWORDS
.IX Header "KEYWORDS"
asynchronous I/O, blocking, filehandle, event handler, nonblocking, readable,
callback, writable.