Time-Out-1.0.0/0000755000032300003110000000000014703713033011604 5ustar micswediTime-Out-1.0.0/.perlcriticrc0000644000032300003110000000072114522632634014300 0ustar micswediseverity = harsh #severity = cruel #severity = brutal verbose = %f: %m at line %l, column %c. (Policy: %p, Severity: %s)\n [-BuiltinFunctions::ProhibitSleepViaSelect] # https://github.com/Perl-Critic/Perl-Critic/issues/1053 [-Modules::RequireEndWithOne] [-Modules::RequireExplicitPackage] [-Subroutines::ProhibitSubroutinePrototypes] [-Subroutines::RequireArgUnpacking] [-Subroutines::RequireFinalReturn] [-ValuesAndExpressions::RequireInterpolationOfMetachars] Time-Out-1.0.0/Changes0000644000032300003110000000403714703712636013113 0ustar micswediRelease history for Time-Out 1.0.0 Wed Oct 16 12:28:54 CEST 2024 - update author extensions - improve dependencies setup in cpanfile - improve README - use version pragma and dotted decimal version - setup CI workflow that is based on the GitHub project PerlToolsTeam/github_workflows 0.24 Mon Nov 27 08:11:23 CET 2023 - Document eval inside timeout handling [rt.cpan.org #128908] - Use exception object instead of coderef in ALRM handler 0.23 Tue Nov 14 10:47:04 CET 2023 - Improve author extensions - Add test case that times out the POSIX pause function - Add missing runtime dependency 0.22 Tue Nov 7 09:57:51 CET 2023 - Streamline exception handling - Introduce experimental timeout exception class 0.21 Sun Nov 5 15:16:08 CET 2023 - Use Try::Tiny - Temporarily fix all Perl::Critic complaints - Change license - Properly classify some tests as release tests 0.20 Fri Nov 3 08:33:59 CET 2023 - Fix POD sample code [rt.cpan.org #100886] - Nested timeouts require minimum Time::HiRes version [rt.cpan.org #84141] - Handle calling context properly [rt.cpan.org #115809] - Change TAP producer: Test to Test::More - Add missing test descriptions - Rename test scripts and add new ones - Consider Perl::Critic feedback (work in progress) 0.11 Tue Jan 15 11:36:27 EST 2008 - Applied patch by Jens Heunemann to fix a race condition as well as some errors related to exception handling 0.10 Thu Sep 13 22:53:28 EDT 2007 - Added support for nested timeouts (thanks to chocolateboy for the patch) - Removed the useless 'affects' syntax - 'timeout' now exported via @EXPORT_OK instead of @EXPORT 0.05 Fri Jan 7 13:33:31 EST 2005 - Updated documentation 0.04 Thu Jan 6 13:33:31 EST 2005 - Added tests for blocking I/O - Added support for Time::HiRes 0.01 Tue Jan 4 10:18:55 2005 - original version; created by h2xs 1.22 with options - AX Time::Out Time-Out-1.0.0/LICENSE0000644000032300003110000004651114522632634012626 0ustar micswediThis software is copyright (c) 2005-2008 Patrick LeBoutillier, 2023 by Sven Willenbuecher. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Terms of the Perl programming language system itself a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or b) the "Artistic License" --- The GNU General Public License, Version 1, February 1989 --- This software is Copyright (c) 2023 by Sven Willenbuecher. This is free software, licensed under: The GNU General Public License, Version 1, February 1989 GNU GENERAL PUBLIC LICENSE Version 1, February 1989 Copyright (C) 1989 Free Software Foundation, Inc. 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The license agreements of most software companies try to keep users at the mercy of those companies. By contrast, our General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. The General Public License applies to the Free Software Foundation's software and to any other program whose authors commit to using it. You can use it for your programs, too. When we speak of free software, we are referring to freedom, not price. Specifically, the General Public License is designed to make sure that you have the freedom to give away or sell copies of free software, that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of a such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must tell them their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any work containing the Program or a portion of it, either verbatim or with modifications. Each licensee is addressed as "you". 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this General Public License and to the absence of any warranty; and give any other recipients of the Program a copy of this General Public License along with the Program. You may charge a fee for the physical act of transferring a copy. 2. You may modify your copy or copies of the Program or any portion of it, and copy and distribute such modifications under the terms of Paragraph 1 above, provided that you also do the following: a) cause the modified files to carry prominent notices stating that you changed the files and the date of any change; and b) cause the whole of any work that you distribute or publish, that in whole or in part contains the Program or any part thereof, either with or without modifications, to be licensed at no charge to all third parties under the terms of this General Public License (except that you may choose to grant warranty protection to some or all third parties, at your option). c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the simplest and most usual way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this General Public License. d) You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. Mere aggregation of another independent work with the Program (or its derivative) on a volume of a storage or distribution medium does not bring the other work under the scope of these terms. 3. You may copy and distribute the Program (or a portion or derivative of it, under Paragraph 2) in object code or executable form under the terms of Paragraphs 1 and 2 above provided that you also do one of the following: a) accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Paragraphs 1 and 2 above; or, b) accompany it with a written offer, valid for at least three years, to give any third party free (except for a nominal charge for the cost of distribution) a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Paragraphs 1 and 2 above; or, c) accompany it with the information you received as to where the corresponding source code may be obtained. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form alone.) Source code for a work means the preferred form of the work for making modifications to it. For an executable file, complete source code means all the source code for all modules it contains; but, as a special exception, it need not include source code for modules which are standard libraries that accompany the operating system on which the executable file runs, or for standard header files or definitions files that accompany that operating system. 4. You may not copy, modify, sublicense, distribute or transfer the Program except as expressly provided under this General Public License. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the Program is void, and will automatically terminate your rights to use the Program under this License. However, parties who have received copies, or rights to use copies, from you under this General Public License will not have their licenses terminated so long as such parties remain in full compliance. 5. By copying, distributing or modifying the Program (or any work based on the Program) you indicate your acceptance of this license to do so, and all its terms and conditions. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. 7. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of the license which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the license, you may choose any version ever published by the Free Software Foundation. 8. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 10. 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 PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS Appendix: How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to humanity, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version. 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 the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19xx name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (a program to direct compilers to make passes at assemblers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice That's all there is to it! --- The Perl Artistic License 1.0 --- This software is Copyright (c) 2023 by Sven Willenbuecher. This is free software, licensed under: The Perl Artistic License 1.0 The "Artistic License" Preamble The intent of this document is to state the conditions under which a Package may be copied, such that the Copyright Holder maintains some semblance of artistic control over the development of the package, while giving the users of the package the right to use and distribute the Package in a more-or-less customary fashion, plus the right to make reasonable modifications. Definitions: "Package" refers to the collection of files distributed by the Copyright Holder, and derivatives of that collection of files created through textual modification. "Standard Version" refers to such a Package if it has not been modified, or has been modified in accordance with the wishes of the Copyright Holder as specified below. "Copyright Holder" is whoever is named in the copyright or copyrights for the package. "You" is you, if you're thinking about copying or distributing this Package. "Reasonable copying fee" is whatever you can justify on the basis of media cost, duplication charges, time of people involved, and so on. (You will not be required to justify it to the Copyright Holder, but only to the computing community at large as a market that must bear the fee.) "Freely Available" means that no fee is charged for the item itself, though there may be fees involved in handling the item. It also means that recipients of the item may redistribute it under the same conditions they received it. 1. You may make and give away verbatim copies of the source form of the Standard Version of this Package without restriction, provided that you duplicate all of the original copyright notices and associated disclaimers. 2. You may apply bug fixes, portability fixes and other modifications derived from the Public Domain or from the Copyright Holder. A Package modified in such a way shall still be considered the Standard Version. 3. You may otherwise modify your copy of this Package in any way, provided that you insert a prominent notice in each changed file stating how and when you changed that file, and provided that you do at least ONE of the following: a) place your modifications in the Public Domain or otherwise make them Freely Available, such as by posting said modifications to Usenet or an equivalent medium, or placing the modifications on a major archive site such as uunet.uu.net, or by allowing the Copyright Holder to include your modifications in the Standard Version of the Package. b) use the modified Package only within your corporation or organization. c) rename any non-standard executables so the names do not conflict with standard executables, which must also be provided, and provide a separate manual page for each non-standard executable that clearly documents how it differs from the Standard Version. d) make other distribution arrangements with the Copyright Holder. 4. You may distribute the programs of this Package in object code or executable form, provided that you do at least ONE of the following: a) distribute a Standard Version of the executables and library files, together with instructions (in the manual page or equivalent) on where to get the Standard Version. b) accompany the distribution with the machine-readable source of the Package with your modifications. c) give non-standard executables non-standard names, and clearly document the differences in manual pages (or equivalent), together with instructions on where to get the Standard Version. d) make other distribution arrangements with the Copyright Holder. 5. You may charge a reasonable copying fee for any distribution of this Package. You may charge any fee you choose for support of this Package. You may not charge a fee for this Package itself. However, you may distribute this Package in aggregate with other (possibly commercial) programs as part of a larger (possibly commercial) software distribution provided that you do not advertise this Package as a product of your own. You may embed this Package's interpreter within an executable of yours (by linking); this shall be construed as a mere form of aggregation, provided that the complete Standard Version of the interpreter is so embedded. 6. The scripts and library files supplied as input to or produced as output from the programs of this Package do not automatically fall under the copyright of this Package, but belong to whoever generated them, and may be sold commercially, and may be aggregated with this Package. If such scripts or library files are aggregated with this Package via the so-called "undump" or "unexec" methods of producing a binary executable image, then distribution of such an image shall neither be construed as a distribution of this Package nor shall it fall under the restrictions of Paragraphs 3 and 4, provided that you do not represent such an executable image as a Standard Version of this Package. 7. C subroutines (or comparably compiled subroutines in other languages) supplied by you and linked into this Package in order to emulate subroutines and variables of the language defined by this Package shall not be considered part of this Package, but are the equivalent of input as in Paragraph 6, provided these subroutines do not change the language in any way that would cause it to fail the regression tests for the language. 8. Aggregation of this Package with a commercial distribution is always permitted provided that the use of this Package is embedded; that is, when no overt attempt is made to make this Package's interfaces visible to the end user of the commercial distribution. Such use shall not be construed as a distribution of this Package. 9. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. The End Time-Out-1.0.0/MANIFEST0000644000032300003110000000102614703713033012734 0ustar micswedi.perlcriticrc Changes cpanfile lib/Time/Out.pm lib/Time/Out.pod lib/Time/Out/Exception.pm lib/Time/Out/ParamConstraints.pm LICENSE maint/AuthorExtensions.pl Makefile.PL MANIFEST This list of files README t/01-load.t t/02-basic.t t/03-no-timeout-exceptions.t t/04-nested.t t/05-RT-100886.t t/06-RT-84141.t t/07-RT-115809.t t/08-RT-128908.t t/09-pod.t t/10-critic.t META.yml Module YAML meta-data (added by MakeMaker) META.json Module JSON meta-data (added by MakeMaker) Time-Out-1.0.0/META.json0000664000032300003110000000463314703713033013235 0ustar micswedi{ "abstract" : "Easily timeout long running operations", "author" : [ "Sven Willenbuecher " ], "dynamic_config" : 0, "generated_by" : "ExtUtils::MakeMaker version 7.70, CPAN::Meta::Converter version 2.150010", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Time-Out", "no_index" : { "directory" : [ "t", "inc" ] }, "prereqs" : { "build" : { "requires" : { "ExtUtils::MakeMaker" : "0" } }, "configure" : { "requires" : { "Config" : "0", "ExtUtils::MakeMaker" : "6.76", "ExtUtils::MakeMaker::CPANfile" : "0.09", "File::Basename" : "0", "File::Spec" : "0", "lib" : "0", "strict" : "0", "subs" : "0", "version" : "0.9915", "warnings" : "0" } }, "runtime" : { "recommends" : { "Time::HiRes" : "1.9726" }, "requires" : { "Carp" : "1.32", "Exporter" : "0", "Scalar::Util" : "0", "Try::Tiny" : "0", "overload" : "0", "perl" : "5.008000", "strict" : "0", "version" : "0.9915", "warnings" : "0" } }, "test" : { "requires" : { "IO::Handle" : "0", "Test::Fatal" : "0", "Test::Harness" : "3.50", "Test::More" : "1.001005", "Test::Needs" : "0" } } }, "provides" : { "Time::Out" : { "file" : "lib/Time/Out.pm", "version" : "v1.0.0" }, "Time::Out::Exception" : { "file" : "lib/Time/Out/Exception.pm", "version" : "v1.0.0" }, "Time::Out::ParamConstraints" : { "file" : "lib/Time/Out/ParamConstraints.pm", "version" : "v1.0.0" } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/XSven/Time-Out/issues" }, "repository" : { "type" : "git", "url" : "git://github.com/XSven/Time-Out.git", "web" : "https://github.com/XSven/Time-Out" } }, "version" : "1.0.0", "x_serialization_backend" : "JSON::PP version 4.16" } Time-Out-1.0.0/META.yml0000664000032300003110000000254414703713032013063 0ustar micswedi--- abstract: 'Easily timeout long running operations' author: - 'Sven Willenbuecher ' build_requires: ExtUtils::MakeMaker: '0' IO::Handle: '0' Test::Fatal: '0' Test::Harness: '3.50' Test::More: '1.001005' Test::Needs: '0' configure_requires: Config: '0' ExtUtils::MakeMaker: '6.76' ExtUtils::MakeMaker::CPANfile: '0.09' File::Basename: '0' File::Spec: '0' lib: '0' strict: '0' subs: '0' version: '0.9915' warnings: '0' dynamic_config: 0 generated_by: 'ExtUtils::MakeMaker version 7.70, CPAN::Meta::Converter version 2.150010' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Time-Out no_index: directory: - t - inc provides: Time::Out: file: lib/Time/Out.pm version: v1.0.0 Time::Out::Exception: file: lib/Time/Out/Exception.pm version: v1.0.0 Time::Out::ParamConstraints: file: lib/Time/Out/ParamConstraints.pm version: v1.0.0 recommends: Time::HiRes: '1.9726' requires: Carp: '1.32' Exporter: '0' Scalar::Util: '0' Try::Tiny: '0' overload: '0' perl: '5.008000' strict: '0' version: '0.9915' warnings: '0' resources: bugtracker: https://github.com/XSven/Time-Out/issues repository: git://github.com/XSven/Time-Out.git version: 1.0.0 x_serialization_backend: 'CPAN::Meta::YAML version 0.018' Time-Out-1.0.0/Makefile.PL0000644000032300003110000000315114703712305013557 0ustar micswediuse strict; use warnings; use Config qw( %Config ); BEGIN { require './maint/AuthorExtensions.pl' unless ( $Config{ osname } =~ m/\A(?:freebsd|openbsd|solaris)\z/ or exists( $ENV{ MAKELEVEL } ) ); } use ExtUtils::MakeMaker::CPANfile qw( WriteMakefile ); if ( !$Config{ d_alarm } ) { die( "Fatal error: alarm(2) is not defined on this system.\n" ); } my %WriteMakefileArgs = ( NAME => 'Time::Out', AUTHOR => 'Sven Willenbuecher ', VERSION_FROM => 'lib/Time/Out.pm', ABSTRACT_FROM => 'lib/Time/Out.pod', LICENSE => 'Perl_5', MIN_PERL_VERSION => '5.8.0', META_MERGE => { 'meta-spec' => { version => 2 }, provides => { 'Time::Out' => { file => 'lib/Time/Out.pm', version => '1.0.0', }, 'Time::Out::Exception' => { file => 'lib/Time/Out/Exception.pm', version => '1.0.0', }, 'Time::Out::ParamConstraints' => { file => 'lib/Time/Out/ParamConstraints.pm', version => '1.0.0', }, }, resources => { repository => { type => 'git', url => 'git://github.com/XSven/Time-Out.git', web => 'https://github.com/XSven/Time-Out', }, bugtracker => { web => 'https://github.com/XSven/Time-Out/issues', }, }, }, clean => { FILES => 'Time-Out-* cover_db' }, dist => { COMPRESS => 'gzip -9f', SUFFIX => 'gz', }, realclean => { FILES => 'local' }, test => { RECURSIVE_TEST_FILES => 1 }, ); WriteMakefile( %WriteMakefileArgs ); Time-Out-1.0.0/README0000644000032300003110000000216114703712305012465 0ustar micswediNAME Time::Out - Easily timeout long running operations EXAMPLE use Time::Out qw( timeout ); # time out the following code block after 5 seconds timeout 5 => sub { # do something that might take a long time... } ; if ( $@ ){ # timeout occured... } INSTALLATION To install this module, use your preferred CPAN client. If this is cpanm then run the command cpanm Time::Out DOCUMENTATION After the installation, you can find further documentation using the commands: perldoc Time::Out MAINTENANCE To maintain this module, run the following commands: cpanm --notest --with-configure --with-develop --no-man-pages --local-lib-contained local --installdeps . perl Makefile.PL make make RELEASE_TESTING=1 test # use Test::Harness make RELEASE_TESTING=1 testp # use TAP::Harness make cover # coverage statistics in vim format COPYRIGHT AND LICENSE This software is copyright (c) 2005-2008 Patrick LeBoutillier, 2023 by Sven Willenbuecher. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Time-Out-1.0.0/cpanfile0000644000032300003110000000301014703712305013303 0ustar micswediuse strict; use warnings; on configure => sub { requires 'Config' => '0'; requires 'ExtUtils::MakeMaker' => '6.76'; # offers the RECURSIVE_TEST_FILES feature requires 'ExtUtils::MakeMaker::CPANfile' => '0'; requires 'File::Basename' => '0'; requires 'File::Spec' => '0'; requires 'lib' => '0'; requires 'strict' => '0'; requires 'subs' => '0'; requires 'version' => '0.9915'; requires 'warnings' => '0'; }; on runtime => sub { requires 'Carp' => '1.32'; # Don't vivify @CARP_NOT and @ISA in caller's namespace requires 'Exporter' => '0'; requires 'Scalar::Util' => '0'; requires 'Try::Tiny' => '0'; requires 'overload' => '0'; requires 'strict' => '0'; requires 'version' => '0.9915'; requires 'warnings' => '0'; recommends 'Time::HiRes' => '1.9726'; }; on test => sub { requires 'IO::Handle' => '0'; requires 'Test::Fatal' => '0'; requires 'Test::Harness' => '3.50'; requires 'Test::More' => '1.001005'; # Subtests accept args requires 'Test::Needs' => '0'; }; on develop => sub { requires 'Devel::Cover' => '1.33'; # Fix cover -test with Build.PL requires 'Perl::Tidy' => '20230701'; requires 'Template' => '0'; requires 'Test::Perl::Critic' => '0'; requires 'Test::Pod' => '1.26'; }; Time-Out-1.0.0/lib/0000755000032300003110000000000014703713032012351 5ustar micswediTime-Out-1.0.0/lib/Time/0000755000032300003110000000000014703713032013247 5ustar micswediTime-Out-1.0.0/lib/Time/Out/0000755000032300003110000000000014703713032014016 5ustar micswediTime-Out-1.0.0/lib/Time/Out/Exception.pm0000644000032300003110000000065614703712305016323 0ustar micswediuse strict; use warnings; package Time::Out::Exception; # https://stackoverflow.com/questions/23407085/why-does-eq-not-work-when-one-argument-has-overloaded-stringification use overload '""' => sub { 'timeout' }, fallback => 1; # keeping the following $VERSION declaration on a single line is important #<<< use version 0.9915; our $VERSION = version->declare( '1.0.0' ); #>>> sub new { shift; bless { @_ }, __PACKAGE__ } 1; Time-Out-1.0.0/lib/Time/Out/ParamConstraints.pm0000644000032300003110000000223614703712305017651 0ustar micswediuse strict; use warnings; package Time::Out::ParamConstraints; # keeping the following $VERSION declaration on a single line is important #<<< use version 0.9915; our $VERSION = version->declare( '1.0.0' ); #>>> use Exporter qw( import ); use Scalar::Util qw( blessed looks_like_number reftype ); our @EXPORT_OK = qw( assert_NonNegativeNumber assert_CodeRef ); sub _is_CodeRef ( $ ); sub _is_String ( $ ); sub _croakf ( $@ ); sub assert_NonNegativeNumber( $ ) { my ( $value ) = @_; _is_String $value && looks_like_number $value && $value !~ /\A (?: Inf (?: inity )? | NaN ) \z/xi && $value >= 0 ? return $value : _croakf 'value is not a non-negative number'; } sub assert_CodeRef( $ ) { my ( $value ) = @_; _is_CodeRef $value ? return $value : _croakf 'value is not a code reference'; } sub _is_CodeRef( $ ) { my ( $value ) = @_; return !defined blessed $value && ref $value eq 'CODE'; } sub _is_String( $ ) { my ( $value ) = @_; return defined $value && reftype \$value eq 'SCALAR'; } sub _croakf( $@ ) { # load Carp lazily require Carp; @_ = ( ( @_ == 1 ? shift : sprintf shift, @_ ) . ', stopped' ); goto &Carp::croak; } 1; Time-Out-1.0.0/lib/Time/Out.pm0000644000032300003110000000561714703712305014367 0ustar micswediuse strict; use warnings; package Time::Out; # keeping the following $VERSION declaration on a single line is important #<<< use version 0.9915; our $VERSION = version->declare( '1.0.0' ); #>>> use Exporter qw( import ); use Scalar::Util qw( blessed reftype ); use Time::Out::Exception qw(); use Time::Out::ParamConstraints qw( assert_NonNegativeNumber assert_CodeRef ); use Try::Tiny qw( finally try ); BEGIN { # if possible use Time::HiRes drop-in replacements for ( qw( alarm time ) ) { Time::HiRes->import( $_ ) if Time::HiRes->can( $_ ); } } our @EXPORT_OK = qw( timeout ); sub timeout( $@ ) { my $context = wantarray; # wallclock seconds my $timeout = assert_NonNegativeNumber shift; my $code = assert_CodeRef pop; my @code_args = @_; my $exception; # in scalar context store the result in the first array element my @result; # disable previous timer and save the amount of time remaining on it my $remaining_time_on_previous_timer = alarm 0; my $start_time = time; { # https://stackoverflow.com/questions/1194113/whats-the-difference-between-ignoring-a-signal-and-telling-it-to-do-nothing-in # disable ALRM handling to prevent possible race condition between the end of the # try block and the execution of alarm(0) in the finally block local $SIG{ ALRM } = 'IGNORE'; try { local $SIG{ ALRM } = sub { die Time::Out::Exception->new( previous_exception => $@, timeout => $timeout ) }; ## no critic (RequireCarping) if ( $remaining_time_on_previous_timer and $remaining_time_on_previous_timer < $timeout ) { # a shorter timer was pending, let's use it instead alarm $remaining_time_on_previous_timer; } else { alarm $timeout; } defined $context ? $context ? @result = $code->( @code_args ) # list context : $result[ 0 ] = $code->( @code_args ) # scalar context : $code->( @code_args ); # void context alarm 0; } finally { alarm 0; $exception = $_[ 0 ] if @_; } } my $elapsed_time = time - $start_time; my $new_timeout = $remaining_time_on_previous_timer - $elapsed_time; if ( $new_timeout > 0 ) { # rearm previous timer with new timeout alarm $new_timeout; } elsif ( $remaining_time_on_previous_timer ) { # previous timer has already expired; send ALRM kill 'ALRM', $$; } # handle exceptions if ( defined $exception ) { if ( defined blessed( $exception ) and $exception->isa( 'Time::Out::Exception' ) ) { $@ = $exception; ## no critic (RequireLocalizedPunctuationVars) return; } die $exception; ## no critic (RequireCarping) } return defined $context ? $context ? return @result # list context : $result[ 0 ] # scalar context : (); # void context } 1; Time-Out-1.0.0/lib/Time/Out.pod0000644000032300003110000000517414703712305014533 0ustar micswedi=pod =head1 NAME Time::Out - Easily timeout long running operations =head1 SYNOPSIS use Time::Out qw( timeout ); timeout $timeout => sub { # your operation is implemented here and will be interrupted # if it runs for more than $timeout seconds }; if ( $@ ) { # operation timed-out } =head1 DESCRIPTION The C module provides an easy interface to L based timeouts. Nested timeouts are supported. The module exports the C function by default. The function returns whatever the code placed inside the subroutine reference returns: use Time::Out qw( timeout ); my $result = timeout 5 => sub { return 7; }; # $result == 7 If C sees that L has been loaded, it will use that C function (if available) instead of the default one, allowing float timeout values to be used effectively: use Time::HiRes qw(); use Time::Out qw( timeout ); timeout 3.1416 => sub { # ... }; =head1 CAVEATS =over 2 =item Blocking I/O on MSWin32 L doesn't interrupt blocking I/O on MSWin32, so C won't do that either. =item @_ One drawback to using C is that it masks C<@_> in the affected code. This happens because the affected code is actually wrapped inside another subroutine that provides it's own C<@_>. You can get around this by specifically passing your C<@_> (or whatever you want for that matter) to C as such: use Time::Out qw( timeout ); sub foo { timeout 5, @_ => sub { @_; }; } my @result = foo( 42, "Hello, World!" ); # @result == ( 42, "Hello, World!" ); =item Eval inside timeout If the affected code has its own exception handling using L for example, the catch block has to be amended in a way so that it will rethrow an exception, if it refers to a timeout: use Scalar::Util qw( blessed ); use Time::Out qw( timeout ); use Try::Tiny qw( catch try ); timeout 5, sub { try { select( undef, undef, undef, 7 ); die "bad\n"; } catch { # rethrow exception, if it refers to a timeout die $_ if defined blessed $_ and $_->isa( 'Time::Out::Exception' ); # handle all other exceptions } }; =back =head1 SEE ALSO L, L =head1 AUTHORS Sven Willenbuecher, Esven.willenbuecher@gmx.deE Patrick LeBoutillier, Epatl@cpan.orgE =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2005-2008 Patrick LeBoutillier, 2023 by Sven Willenbuecher. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut Time-Out-1.0.0/maint/0000755000032300003110000000000014703713032012713 5ustar micswediTime-Out-1.0.0/maint/AuthorExtensions.pl0000644000032300003110000000445314703712305016602 0ustar micswediuse strict; use warnings; use subs qw ( _which ); use Config qw( %Config ); use File::Basename qw( basename ); use File::Spec qw(); my ( $local_lib_root, $local_bin, $local_lib, $prove_rc_file, $t_lib ); BEGIN { $local_lib_root = File::Spec->catfile( $ENV{ PWD }, 'local' ); $local_bin = File::Spec->catfile( $local_lib_root, qw( bin ) ); $local_lib = File::Spec->catfile( $local_lib_root, qw( lib perl5 ) ); $prove_rc_file = File::Spec->catfile( $ENV{ PWD }, qw( t .proverc ) ); $t_lib = File::Spec->catfile( $ENV{ PWD }, qw( t lib ) ); } use lib $local_lib; # do not use "local" in the following line because then _which() will no see # the modified PATH $ENV{ PATH } = ## no critic (RequireLocalizedPunctuationVars) exists $ENV{ PATH } ? "$local_bin$Config{ path_sep }$ENV{ PATH }" : $local_bin; ## no critic (RequireLocalizedPunctuationVars) { no warnings 'once'; ## no critic (ProhibitNoWarnings) *MY::postamble = sub { my $make_fragment = ''; $make_fragment .= <<"MAKE_FRAGMENT"; export PATH := $ENV{ PATH } ifdef PERL5LIB PERL5LIB := ${ \( -d $t_lib ? "$t_lib:" : '' ) }$local_lib:\$(PERL5LIB) else export PERL5LIB := ${ \( -d $t_lib ? "$t_lib:" : '' ) }$local_lib endif # runs the last modified test script .PHONY: testlm testlm: \$(NOECHO) \$(MAKE) TEST_FILES=\$\$(perl -e 'print STDOUT ( sort { -M \$\$a > -M \$\$b } glob( "\$\$ARGV[0]" ) )[0]' '\$(TEST_FILES)') test MAKE_FRAGMENT my $prove = _which 'prove'; $make_fragment .= <<"MAKE_FRAGMENT" if $prove; # runs test scripts through TAP::Harness (prove) instead of Test::Harness (ExtUtils::MakeMaker) .PHONY: testp testp: pure_all \$(NOECHO) $prove\$(if \$(TEST_VERBOSE:0=), --verbose) --norc${ \( -f $prove_rc_file ? " --rc $prove_rc_file" : '' ) } --blib --recurse --shuffle \$(TEST_FILES) MAKE_FRAGMENT my $cover = _which 'cover'; $make_fragment .= <<"MAKE_FRAGMENT" if $cover; .PHONY: cover cover: \$(NOECHO) $cover -test -ignore ${ \( basename( $local_lib_root ) ) } -report vim MAKE_FRAGMENT return $make_fragment; }; } sub _which ( $ ) { my ( $executable ) = @_; for ( split /$Config{ path_sep }/, $ENV{ PATH } ) { ## no critic (RequireExtendedFormatting) my $file = File::Spec->catfile( $_, $executable ); return $file if -x $file; } return; } Time-Out-1.0.0/t/0000755000032300003110000000000014703713032012046 5ustar micswediTime-Out-1.0.0/t/01-load.t0000644000032300003110000000025014703712305013367 0ustar micswediuse strict; use warnings; use Test::More import => [ qw( BAIL_OUT use_ok ) ], tests => 1; BEGIN { use_ok 'Time::Out' or BAIL_OUT 'Cannot load Time::Out module!'; } Time-Out-1.0.0/t/02-basic.t0000644000032300003110000000410114703712305013531 0ustar micswediuse strict; use warnings; # Load Time::Out before Test::More: Recent version of Test::More load # Time::HiRes. This should be avoided. use Time::Out qw( timeout ); use Test::More import => [ qw( is is_deeply plan skip subtest ) ], tests => 6; use POSIX qw( ); subtest 'timeout: void context; keep the CPU busy' => sub { plan tests => 1; timeout 2 => sub { while ( 1 ) { } }; is $@, 'timeout', 'eval error was set to "timeout"'; }; SKIP: { skip 'POSIX module does not provide pause() implementation', 1 unless POSIX->can( 'pause' ); subtest 'timeout: void context; pause the current process' => sub { plan tests => 1; timeout 2 => sub { POSIX::pause(); }; is $@, 'timeout', 'eval error was set to "timeout"'; }; } SKIP: { skip "alarm(2) doesn't interrupt blocking I/O on $^O", 1 if $^O eq 'MSWin32'; subtest 'timeout: void context; blocking I/O' => sub { plan tests => 1; require IO::Handle; my $rh = IO::Handle->new; my $wh = IO::Handle->new; pipe( $rh, $wh ); $wh->autoflush( 1 ); print $wh "\n"; my $line = <$rh>; timeout 2 => sub { $line = <$rh>; }; is $@, 'timeout', 'eval error was set to "timeout"'; }; } subtest 'no timeout: void context' => sub { plan tests => 1; timeout 3 => sub { select( undef, undef, undef, 1 ); }; is $@, '', 'empty eval error'; }; subtest 'no timeout: scalar context; echo argument passed to code' => sub { plan tests => 2; my $expected_result = 42; my $got_result = timeout 3, $expected_result => sub { select( undef, undef, undef, 1 ); $_[ 0 ]; }; is $@, '', 'empty eval error'; is $got_result, $expected_result, 'expected result'; }; subtest 'no timeout: list context; echo arguments passed to code' => sub { plan tests => 2; my $expected_result = [ 42, 'Hello, World!' ]; my $got_result = [ timeout 3, @$expected_result => sub { select( undef, undef, undef, 1 ); @_; } ]; is $@, '', 'empty eval error'; is_deeply $got_result, $expected_result, 'expected result'; }; Time-Out-1.0.0/t/03-no-timeout-exceptions.t0000644000032300003110000000215114703712305016733 0ustar micswediuse strict; use warnings; # Load Time::Out before Test::More: Recent version of Test::More load # Time::HiRes. This should be avoided. use Time::Out qw( timeout ); use Test::More import => [ qw( is like ) ], tests => 5; use Test::Fatal qw( exception ); ## no critic (RequireCarping) my $expected_value = "Hello\n"; is exception { timeout 3 => sub { die( $expected_value ); }; }, $expected_value, 'no timeout: code dies (exception is a string with trailing newline)'; like exception { timeout 3 => sub { die( 'Hello' ) }; }, qr/\A Hello\ at\ /x, 'no timeout: code dies (exception is a string without trailing newline)'; $expected_value = 42; is exception { timeout 3 => sub { die( [ $expected_value ] ) }; } ->[ 0 ], $expected_value, 'no timeout: code dies (exception is a plain array reference)'; my $foo = bless {}, 'Foo::Exception'; is exception { timeout 3 => sub { die $foo }; }, $foo, 'no timeout: code dies (exception is an object)'; $foo = sub { $expected_value }; is exception { timeout 3 => sub { die $foo }; } ->(), $expected_value, 'no timeout: code dies (exception is a plain code reference)'; Time-Out-1.0.0/t/04-nested.t0000644000032300003110000000146214703712305013743 0ustar micswediuse strict; use warnings; # Load Time::Out before Test::More: Recent version of Test::More load # Time::HiRes. This should be avoided. use Time::Out qw( timeout ); use Test::More import => [ qw( fail is plan subtest ) ], tests => 2; subtest 'inner timer fires before outer timer' => sub { plan tests => 2; timeout 5 => sub { timeout 2 => sub { while ( 1 ) { } }; is $@, 'timeout', 'inner timeout: eval error was set to "timeout"'; while ( 1 ) { } }; is $@, 'timeout', 'outer timeout: eval error was set to "timeout"'; }; subtest 'outer timer interrupts inner timer' => sub { plan tests => 1; timeout 2 => sub { timeout 5 => sub { while ( 1 ) { } }; fail 'we should never get here'; }; is $@, 'timeout', 'outer timeout: eval error was set to "timeout"'; }; Time-Out-1.0.0/t/05-RT-100886.t0000644000032300003110000000036714703712305013556 0ustar micswediuse strict; use warnings; use Time::HiRes qw(); use Time::Out qw( timeout ); use Test::More import => [ qw( fail pass ) ], tests => 1; timeout 0.1 => sub { sleep 1; }; if ( $@ ) { pass 'Timeout happened'; } else { fail 'No timeout'; } Time-Out-1.0.0/t/06-RT-84141.t0000644000032300003110000000074214703712305013467 0ustar micswediuse strict; use warnings; use Test::More import => [ qw( is plan ) ]; BEGIN { plan eval { require Time::HiRes; Time::HiRes->VERSION( '1.9726' ); } ? ( tests => 2 ) : ( skip_all => 'Time::HiRes 1.9726 needed but is not installed' ); } use Time::Out qw( timeout ); for my $timeout ( ( 2148, 86400 ) ) { my $result = timeout $timeout => sub { alarm 0; }; is $result, $timeout, "disable timer and return the amount of time remaining on it ($timeout seconds)"; } Time-Out-1.0.0/t/07-RT-115809.t0000644000032300003110000000057714703712305013564 0ustar micswediuse strict; use warnings; use Time::Out qw( timeout ); use Test::More import => [ qw( is ) ], tests => 2; my $code = sub { wantarray ? 'array' : 'scalar'; }; my $expected_context = 'scalar'; { my $result = $code->(); is $result, $expected_context, 'scalar context'; } { my $result = timeout 100 => $code; is $result, $expected_context, 'no timeout: scalar context'; } Time-Out-1.0.0/t/08-RT-128908.t0000644000032300003110000000103014703712305013552 0ustar micswediuse strict; use warnings; use Scalar::Util qw( blessed ); use Time::Out qw( timeout ); use Try::Tiny qw( catch try ); use Test::More import => [ qw( fail is ) ], tests => 1; timeout 1, sub { try { select( undef, undef, undef, 5 ); die "bad\n"; } catch { # rethrow exception, if it refers to a timeout die $_ if defined blessed $_ and $_->isa( 'Time::Out::Exception' ); ## no critic (RequireCarping) fail( 'timeout should fire before die' ); } }; is $@, 'timeout', 'eval error was set to "timeout"'; Time-Out-1.0.0/t/09-pod.t0000644000032300003110000000046214703712305013247 0ustar micswediuse strict; use warnings; use Test::More import => [ qw( plan ) ]; BEGIN { plan skip_all => 'Not release testing context' unless $ENV{ RELEASE_TESTING } } # ensure a recent version of Test::Pod; consider updating the cpanfile too use Test::Needs { 'Test::Pod' => 1.26 }; Test::Pod::all_pod_files_ok(); Time-Out-1.0.0/t/10-critic.t0000644000032300003110000000040314703712305013725 0ustar micswediuse strict; use warnings; use Test::More import => [ qw( plan ) ]; BEGIN { plan skip_all => 'Not release testing context' unless $ENV{ RELEASE_TESTING } } use Test::Needs qw( Test::Perl::Critic ); Test::Perl::Critic::all_critic_ok( 'lib', 't', 'maint' );