104 lines
2.5 KiB
Perl
104 lines
2.5 KiB
Perl
|
#---------------------------------------------------------------------
|
||
|
|
package Win32::Event;
|
||
|
|
#
|
||
|
|
# Copyright 1998 Christopher J. Madsen
|
||
|
|
#
|
||
|
|
# Author: Christopher J. Madsen <chris_madsen@geocities.com>
|
||
|
|
# Created: 3 Feb 1998 from the ActiveWare version
|
||
|
|
# Version: 1.00 (6-Feb-1998)
|
||
|
|
#
|
||
|
|
# This program is free software; you can redistribute it and/or modify
|
||
|
|
# it under the same terms as Perl itself.
|
||
|
|
#
|
||
|
|
# This program is distributed in the hope that it will be useful,
|
||
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either the
|
||
|
|
# GNU General Public License or the Artistic License for more details.
|
||
|
|
#
|
||
|
|
# Use Win32 event objects for synchronization
|
||
|
|
#---------------------------------------------------------------------
|
||
|
|
|
||
|
|
$VERSION = '1.00';
|
||
|
|
|
||
|
|
use Win32::IPC 1.00 '/./'; # Import everything
|
||
|
|
require Exporter;
|
||
|
|
require DynaLoader;
|
||
|
|
|
||
|
|
@ISA = qw(Exporter DynaLoader Win32::IPC);
|
||
|
|
@EXPORT_OK = qw(
|
||
|
|
wait_all wait_any INFINITE
|
||
|
|
);
|
||
|
|
|
||
|
|
bootstrap Win32::Event;
|
||
|
|
|
||
|
|
1;
|
||
|
|
__END__
|
||
|
|
|
||
|
|
=head1 NAME
|
||
|
|
|
||
|
|
Win32::Event - Use Win32 event objects from Perl
|
||
|
|
|
||
|
|
=head1 SYNOPSIS
|
||
|
|
|
||
|
|
use Win32::Event;
|
||
|
|
|
||
|
|
$event = Win32::Event->new($manual,$initial,$name);
|
||
|
|
$event->wait();
|
||
|
|
|
||
|
|
=head1 DESCRIPTION
|
||
|
|
|
||
|
|
This module allows access to the Win32 event objects. The C<wait>
|
||
|
|
method and C<wait_all> & C<wait_any> functions are inherited from the
|
||
|
|
L<"Win32::IPC"> module.
|
||
|
|
|
||
|
|
=head2 Methods
|
||
|
|
|
||
|
|
=over 4
|
||
|
|
|
||
|
|
=item $event = Win32::Event->new([$manual, [$initial, [$name]]])
|
||
|
|
|
||
|
|
Constructor for a new event object. If C<$manual> is true, you must
|
||
|
|
manually reset the event after it is signalled (the default is false).
|
||
|
|
If C<$initial> is true, the initial state of the object is signalled
|
||
|
|
(default false). If C<$name> is omitted, creates an unnamed event
|
||
|
|
object.
|
||
|
|
|
||
|
|
If C<$name> signifies an existing event object, then C<$manual> and
|
||
|
|
C<$initial> are ignored and the object is opened.
|
||
|
|
|
||
|
|
=item $event = Win32::Event->open($name)
|
||
|
|
|
||
|
|
Constructor for opening an existing event object.
|
||
|
|
|
||
|
|
=item $event->pulse
|
||
|
|
|
||
|
|
Signal the C<$event> and then immediately reset it. If C<$event> is a
|
||
|
|
manual-reset event, releases all threads currently blocking on it. If
|
||
|
|
it's an auto-reset event, releases just one thread.
|
||
|
|
|
||
|
|
If no threads are waiting, just resets the event.
|
||
|
|
|
||
|
|
=item $event->reset
|
||
|
|
|
||
|
|
Reset the C<$event> to nonsignalled.
|
||
|
|
|
||
|
|
=item $event->set
|
||
|
|
|
||
|
|
Set the C<$event> to signalled.
|
||
|
|
|
||
|
|
=item $event->wait([$timeout])
|
||
|
|
|
||
|
|
Wait for C<$event> to be signalled. See L<"Win32::IPC">.
|
||
|
|
|
||
|
|
=back
|
||
|
|
|
||
|
|
=head1 AUTHOR
|
||
|
|
|
||
|
|
Christopher J. Madsen E<lt>F<chris_madsen@geocities.com>E<gt>
|
||
|
|
|
||
|
|
=cut
|
||
|
|
|
||
|
|
# Local Variables:
|
||
|
|
# tmtrack-file-task: "Win32::Event"
|
||
|
|
# End:
|