Win32::Event - Use Win32 event objects from Perl


NAME

Win32::Event - Use Win32 event objects from Perl

Back to Top


VERSION

This document describes version 1.07 of Win32::Event, released April 16, 2008 as part of Win32-IPC version 1.07.

Back to Top


SYNOPSIS

        use Win32::Event;
        $event = Win32::Event->new($manual,$initial,$name);
        $event->wait();

Back to Top


DESCRIPTION

This module allows access to the Win32 event objects. The wait method and wait_all & wait_any functions are inherited from the the Win32::IPC manpage module.

Methods

$event = Win32::Event->new([$manual, [$initial, [$name]]])

Constructor for a new event object. If $manual is true, you must manually reset the event after it is signalled (the default is false). If $initial is true, the initial state of the object is signalled (default false). If $name is omitted or undef, creates an unnamed event object.

If $name signifies an existing event object, then $manual and $initial are ignored and the object is opened. If this happens, $^E will be set to 183 (ERROR_ALREADY_EXISTS).

$event = Win32::Event->open($name)

Constructor for opening an existing event object.

$event->pulse

Microsoft has stated this function is unreliable and should be avoided. Consult Microsoft's documentation for PulseEvent for details.

Signal the $event and then immediately reset it. If $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.

It returns a true value if successful, or zero on failure (additional error information can be found in $^E).

$event->reset

Reset the $event to nonsignalled. It returns a true value if successful, or zero on failure (additional error information can be found in $^E).

$event->set

Set the $event to signalled. It returns a true value if successful, or zero on failure (additional error information can be found in $^E).

$event->wait([$timeout])

Wait for $event to be signalled. See the Win32::IPC manpage.

Back to Top


DIAGNOSTICS

None.

Back to Top


CONFIGURATION AND ENVIRONMENT

Win32::Event requires no configuration files or environment variables.

It runs under 32-bit or 64-bit Microsoft Windows, either natively or under Cygwin.

Back to Top


DEPENDENCIES

the Win32::IPC manpage

Back to Top


INCOMPATIBILITIES

Prior to version 1.06, Win32::Event treated undef values differently. In version 1.06 and later, passing undef as the value of an optional parameter is the same as omitting that parameter. In previous versions, undef was interpreted as either the empty string or 0 (along with a warning about "Use of uninitialized value...").

Back to Top


BUGS AND LIMITATIONS

No bugs have been reported.

Back to Top


AUTHOR

Christopher J. Madsen <perl AT cjmweb.net>

Please report any bugs or feature requests to <bug-Win32-IPC AT rt.cpan.org> >, or through the web interface at http://rt.cpan.org/Public/Bug/Report.html

Back to Top


LICENSE AND COPYRIGHT

Copyright 1998-2008 Christopher J. Madsen

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

Back to Top


DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Back to Top

 Win32::Event - Use Win32 event objects from Perl