Debian Codegraph @

upstream/debian-unstable/man3/IO::Poll.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "IO::Poll 3perl"
58 .TH IO::Poll 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 IO::Poll \- Object interface to system poll call
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use IO::Poll qw(POLLRDNORM POLLWRNORM POLLIN POLLHUP);
69 \&
70 \& $poll = IO::Poll\->new();
71 \&
72 \& $poll\->mask($input_handle => POLLIN);
73 \& $poll\->mask($output_handle => POLLOUT);
74 \&
75 \& $poll\->poll($timeout);
76 \&
77 \& $ev = $poll\->events($input);
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 \&\f(CW\*(C`IO::Poll\*(C'\fR is a simple interface to the system level poll routine.
82 .SH METHODS
83 .IX Header "METHODS"
84 .IP "mask ( IO [, EVENT_MASK ] )" 4
85 .IX Item "mask ( IO [, EVENT_MASK ] )"
86 If EVENT_MASK is given, then, if EVENT_MASK is non-zero, IO is added to the
87 list of file descriptors and the next call to poll will check for
88 any event specified in EVENT_MASK. If EVENT_MASK is zero then IO will be
89 removed from the list of file descriptors.
90 .Sp
91 If EVENT_MASK is not given then the return value will be the current
92 event mask value for IO.
93 .IP "poll ( [ TIMEOUT ] )" 4
94 .IX Item "poll ( [ TIMEOUT ] )"
95 Call the system level poll routine. If TIMEOUT is not specified then the
96 call will block. Returns the number of handles which had events
97 happen, or \-1 on error.
98 .IP "events ( IO )" 4
99 .IX Item "events ( IO )"
100 Returns the event mask which represents the events that happened on IO
101 during the last call to \f(CW\*(C`poll\*(C'\fR.
102 .IP "remove ( IO )" 4
103 .IX Item "remove ( IO )"
104 Remove IO from the list of file descriptors for the next poll.
105 .IP "handles( [ EVENT_MASK ] )" 4
106 .IX Item "handles( [ EVENT_MASK ] )"
107 Returns a list of handles. If EVENT_MASK is not given then a list of all
108 handles known will be returned. If EVENT_MASK is given then a list
109 of handles will be returned which had one of the events specified by
110 EVENT_MASK happen during the last call ti \f(CW\*(C`poll\*(C'\fR
111 .SH "SEE ALSO"
112 .IX Header "SEE ALSO"
113 \&\fBpoll\fR\|(2), IO::Handle, IO::Select
114 .SH AUTHOR
115 .IX Header "AUTHOR"
116 Graham Barr. Currently maintained by the Perl Porters. Please report all
117 bugs at <https://github.com/Perl/perl5/issues>.
118 .SH COPYRIGHT
119 .IX Header "COPYRIGHT"
120 Copyright (c) 1997\-8 Graham Barr <[email protected]>. All rights reserved.
121 This program is free software; you can redistribute it and/or
122 modify it under the same terms as Perl itself.