SYBER / UniEvent-1.2.6 / lib / UniEvent / Prepare.pod 

            

              
—
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77

              
=head1 NAME
UniEvent::Prepare - run the given callback once per loop iteration, right before polling for i/o.
=head1 SYNOPSIS
    my $h = UniEvent::Prepare->new($loop);
    $h->event->add(sub { say 'hello' });
    $h->start;
    $loop->run_nowait;  # prints 'hello'
    $loop->run_nowait;  # prints 'hello' again
    $h->stop;
    $loop->run_nowait;  # no effect
    $h = UE::prepare sub { ... }, $loop;
=head1 DESCRIPTION
The Prepare handle is useful for doing some actions before polling for I/O.
It is inherited from L<UniEvent::Handle>.
=head1 METHODS
All methods of L<UniEvent::Handle> also apply.
=head2 create($callback, [$loop = default])
    my $handle = UniEvent::Prepare->create(sub { say "hi" });
Creates and starts a prepare handle. Alias for C<new($loop)> + C<start($callback)>.
=head2 new([$loop = default])
Constructs new Prepare handle and binds it to the specified event loop
=head2 start([$callback])
Starts the prepare handle, i.e. makes it active for the next even loop
iteration. Optionally it adds the C<$callback> to the event listeners.
=head2 stop()
Stops the prepare handle, i.e. makes it inactive for the next event loop iteration.
=head2 callback($sub)
=head2 event()
Callback signature:
    my $handle = shift; # the "prepare" handle itself
See L<UniEvent/"EVENT CALLBACKS">
=head2 event_listener($delegate, [$weak])
Method C<on_prepare> will be called.
See L<UniEvent/"EVENT LISTENER">
=head2 call_now()
Immediately ivokes assigned callbacks and listeners.
=cut