Debian Codegraph @

upstream/opensuse-tumbleweed/man3/IO::Poll.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "IO::Poll 3pm"
61 .TH IO::Poll 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 IO::Poll \- Object interface to system poll call
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use IO::Poll qw(POLLRDNORM POLLWRNORM POLLIN POLLHUP);
72 \&
73 \& $poll = IO::Poll\->new();
74 \&
75 \& $poll\->mask($input_handle => POLLIN);
76 \& $poll\->mask($output_handle => POLLOUT);
77 \&
78 \& $poll\->poll($timeout);
79 \&
80 \& $ev = $poll\->events($input);
81 .Ve
82 .SH DESCRIPTION
83 .IX Header "DESCRIPTION"
84 \&\f(CW\*(C`IO::Poll\*(C'\fR is a simple interface to the system level poll routine.
85 .SH METHODS
86 .IX Header "METHODS"
87 .IP "mask ( IO [, EVENT_MASK ] )" 4
88 .IX Item "mask ( IO [, EVENT_MASK ] )"
89 If EVENT_MASK is given, then, if EVENT_MASK is non\-zero, IO is added to the
90 list of file descriptors and the next call to poll will check for
91 any event specified in EVENT_MASK. If EVENT_MASK is zero then IO will be
92 removed from the list of file descriptors.
93 .Sp
94 If EVENT_MASK is not given then the return value will be the current
95 event mask value for IO.
96 .IP "poll ( [ TIMEOUT ] )" 4
97 .IX Item "poll ( [ TIMEOUT ] )"
98 Call the system level poll routine. If TIMEOUT is not specified then the
99 call will block. Returns the number of handles which had events
100 happen, or \-1 on error.
101 .IP "events ( IO )" 4
102 .IX Item "events ( IO )"
103 Returns the event mask which represents the events that happened on IO
104 during the last call to \f(CW\*(C`poll\*(C'\fR.
105 .IP "remove ( IO )" 4
106 .IX Item "remove ( IO )"
107 Remove IO from the list of file descriptors for the next poll.
108 .IP "handles( [ EVENT_MASK ] )" 4
109 .IX Item "handles( [ EVENT_MASK ] )"
110 Returns a list of handles. If EVENT_MASK is not given then a list of all
111 handles known will be returned. If EVENT_MASK is given then a list
112 of handles will be returned which had one of the events specified by
113 EVENT_MASK happen during the last call to \f(CW\*(C`poll\*(C'\fR.
114 .SH "SEE ALSO"
115 .IX Header "SEE ALSO"
116 \&\fBpoll\fR\|(2), IO::Handle, IO::Select
117 .SH AUTHOR
118 .IX Header "AUTHOR"
119 Graham Barr. Currently maintained by the Perl Porters. Please report all
120 bugs at <https://github.com/Perl/perl5/issues>.
121 .SH COPYRIGHT
122 .IX Header "COPYRIGHT"
123 Copyright (c) 1997\-8 Graham Barr <[email protected]>. All rights reserved.
124 This program is free software; you can redistribute it and/or
125 modify it under the same terms as Perl itself.