.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.TH IO::Poll 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
IO::Poll \- Object interface to system poll call
\& use IO::Poll qw(POLLRDNORM POLLWRNORM POLLIN POLLHUP);
\& $poll->mask($input_handle => POLLIN);
\& $poll->mask($output_handle => POLLOUT);
\& $poll->poll($timeout);
\& $ev = $poll->events($input);
\&\f(CW\*(C`IO::Poll\*(C'\fR is a simple interface to the system level poll routine.
.IP "mask ( \s-1IO\s0 [, \s-1EVENT_MASK\s0 ] )" 4
.IX Item "mask ( IO [, EVENT_MASK ] )"
If \s-1EVENT_MASK\s0 is given, then, if \s-1EVENT_MASK\s0 is non\-zero, \s-1IO\s0 is added to the
list of file descriptors and the next call to poll will check for
any event specified in \s-1EVENT_MASK\s0. If \s-1EVENT_MASK\s0 is zero then \s-1IO\s0 will be
removed from the list of file descriptors.
If \s-1EVENT_MASK\s0 is not given then the return value will be the current
event mask value for \s-1IO\s0.
.IP "poll ( [ \s-1TIMEOUT\s0 ] )" 4
.IX Item "poll ( [ TIMEOUT ] )"
Call the system level poll routine. If \s-1TIMEOUT\s0 is not specified then the
call will block. Returns the number of handles which had events
.IP "events ( \s-1IO\s0 )" 4
Returns the event mask which represents the events that happened on \s-1IO\s0
during the last call to \f(CW\*(C`poll\*(C'\fR.
.IP "remove ( \s-1IO\s0 )" 4
Remove \s-1IO\s0 from the list of file descriptors for the next poll.
.IP "handles( [ \s-1EVENT_MASK\s0 ] )" 4
.IX Item "handles( [ EVENT_MASK ] )"
Returns a list of handles. If \s-1EVENT_MASK\s0 is not given then a list of all
handles known will be returned. If \s-1EVENT_MASK\s0 is given then a list
of handles will be returned which had one of the events specified by
\&\s-1EVENT_MASK\s0 happen during the last call ti \f(CW\*(C`poll\*(C'\fR
\&\fIpoll\fR\|(2), IO::Handle, IO::Select
Graham Barr. Currently maintained by the Perl Porters. Please report all
bugs to <perl5\-porters@perl.org>.
Copyright (c) 1997\-8 Graham Barr <gbarr@pobox.com>. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.