Future-Queue-0.52000755001750001750 014545247010 12517 5ustar00leoleo000000000000Future-Queue-0.52/.editorconfig000444001750001750 5314545247010 15267 0ustar00leoleo000000000000root = true [*.{pm,pl,t}] indent_size = 3 Future-Queue-0.52/Build.PL000444001750001750 65614545247010 14137 0ustar00leoleo000000000000use v5; use strict; use warnings; use Module::Build; my $build = Module::Build->new( module_name => 'Future::Queue', requires => { 'perl' => '5.014', 'Future' => 0, }, test_requires => { 'Test2::V0' => 0, }, configure_requires => { 'Module::Build' => '0.4004', # test_requires }, license => 'perl', create_license => 1, create_readme => 1, ); $build->create_build_script; Future-Queue-0.52/Changes000444001750001750 147414545247010 14155 0ustar00leoleo000000000000Revision history for Future-Queue 0.52 2024-01-03 [BUGFIXES] * Avoid an infinite deep recursion on `_manage_push_waiters` (RT151010) 0.51 2023-02-08 [CHANGES] * Allow specifying a different class, prototype instance, or constructor-like coderef for creating pending Future instances (helps with RT146025) * Swap all unit tests from `Test::More` to `Test2::V0` 0.50 2023-01-16 [CHANGES] * Optional maximum size; push will return a pending future until there's room * Added bulk push and shift API for efficiently handling multiple items at once * Added concept of "finished" queue, where shift returns empty 0.49 2022-10-17 Extracted from Future distribution into its own Future-Queue-0.52/LICENSE000444001750001750 4375514545247010 13717 0ustar00leoleo000000000000This software is copyright (c) 2024 by Paul Evans . 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) 2024 by Paul Evans . 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 Artistic License 1.0 --- This software is Copyright (c) 2024 by Paul Evans . This is free software, licensed under: The 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. - "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 ftp.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) accompany any non-standard executables with their corresponding Standard Version executables, giving the non-standard executables non-standard names, and clearly documenting 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. 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 whomever generated them, and may be sold commercially, and may be aggregated with this Package. 7. C or perl subroutines supplied by you and linked into this Package shall not be considered part of this Package. 8. The name of the Copyright Holder may not be used to endorse or promote products derived from this software without specific prior written permission. 9. 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 Future-Queue-0.52/MANIFEST000444001750001750 31314545247010 13762 0ustar00leoleo000000000000.editorconfig Build.PL Changes lib/Future/Queue.pm LICENSE MANIFEST This list of files META.json META.yml README t/00use.t t/01queue.t t/02max-items.t t/03finish.t t/04bulk.t t/05prototype.t t/99pod.t Future-Queue-0.52/META.json000444001750001750 204014545247010 14271 0ustar00leoleo000000000000{ "abstract" : "a FIFO queue of values that uses Ls", "author" : [ "Paul Evans " ], "dynamic_config" : 1, "generated_by" : "Module::Build version 0.4234", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : 2 }, "name" : "Future-Queue", "prereqs" : { "configure" : { "requires" : { "Module::Build" : "0.4004" } }, "runtime" : { "requires" : { "Future" : "0", "perl" : "5.014" } }, "test" : { "requires" : { "Test2::V0" : "0" } } }, "provides" : { "Future::Queue" : { "file" : "lib/Future/Queue.pm", "version" : "0.52" } }, "release_status" : "stable", "resources" : { "license" : [ "http://dev.perl.org/licenses/" ] }, "version" : "0.52", "x_serialization_backend" : "JSON::PP version 4.07" } Future-Queue-0.52/META.yml000444001750001750 122314545247010 14123 0ustar00leoleo000000000000--- abstract: 'a FIFO queue of values that uses Ls' author: - 'Paul Evans ' build_requires: Test2::V0: '0' configure_requires: Module::Build: '0.4004' dynamic_config: 1 generated_by: 'Module::Build version 0.4234, 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: Future-Queue provides: Future::Queue: file: lib/Future/Queue.pm version: '0.52' requires: Future: '0' perl: '5.014' resources: license: http://dev.perl.org/licenses/ version: '0.52' x_serialization_backend: 'CPAN::Meta::YAML version 0.018' Future-Queue-0.52/README000444001750001750 1032514545247010 13555 0ustar00leoleo000000000000NAME Future::Queue - a FIFO queue of values that uses Futures SYNOPSIS use Future::Queue; use Future::AsyncAwait; my $queue = Future::Queue->new; async sub process_queue { while(1) { my $thing = await $queue->shift; ... } } my $f = process_queue(); $queue->push( "a thing" ); DESCRIPTION Objects in this class provide a simple FIFO queue the stores arbitrary perl values. Values may be added into the queue using the "push" method, and retrieved from it using the "shift" method. Values may be stored within the queue object for shift to retrieve later, or if the queue is empty then the future that shift returns will be completed once an item becomes available. CONSTRUCTOR new $queue = Future::Queue->new( %params ); Returns a new Future::Queue instance. Takes the following named arguments: max_items => INT Since version 0.50. Optional. If defined, there can be at most the given number of items in the queue. Attempts to call "push" beyond that will yield a future that remains pending, until a subsequent "shift" operation makes enough space. prototype => STRING or OBJECT or CODE Since verison 0.51. Optional. If defined, gives either a class name, an object instance to clone or a code reference to invoke when a new pending Future instance is needed by the shift or push methods when they cannot complete immediately. $f = $prototype->(); # if CODE reference $f = $prototype->new; # otherwise If not provided, a default of Future will be used. push $queue->push( @items ); await $queue->push( @items ); Adds more items into the queue. If the queue was previously empty and there is at least one shift future waiting, then the next one will be completed by this method. Since version 0.50 this can take multiple items; earlier versions can only take one value at once. This method always returns a Future instance. If max_items is defined then it is possible that this future will be in a still-pending state; indicating that there was not yet space in the queue to add the items. It will become completed once enough "shift" calls have been made to make space for them. If max_items is not defined then these instances will always be immediately complete; it is safe to drop or ignore it, or call the method in void context. If the queue has been finished then more items cannot be pushed and an exception will be thrown. shift $item = await $queue->shift; Returns a Future that will yield the next item from the queue. If there is already an item then this will be taken and the returned future will be immediate. If not, then the returned future will be pending, and the next push method will complete it. If the queue has been finished then the future will yield an empty list, or undef in scalar context. If undef is a valid item in your queue, make sure to test this condition carefully. For example: while( ( my $item ) = await $queue->shift ) { ... } Here, the await expression and the assignment are in list context, so the loop will continue to iterate while any value is assigned, even if that value is undef. The loop will only stop once no items are returned, indicating the end of the queue. shift_atmost @items = await $queue->shift_atmost( $count ); Since version 0.50. A bulk version of "shift" that can return multiple items at once. Returns a Future that will yield the next few items from the queue. If there is already at least one item in the queue then up to $count items will be taken, and the returned future will be immediate. If not, then the returned future will be pending and the next push method will complete it. finish $queue->finish; Since version 0.50. Marks that the queue is now finished. Once the current list of items has been exhausted, any further attempts to shift more will yield empty. AUTHOR Paul Evans Future-Queue-0.52/lib000755001750001750 014545247010 13265 5ustar00leoleo000000000000Future-Queue-0.52/lib/Future000755001750001750 014545247010 14537 5ustar00leoleo000000000000Future-Queue-0.52/lib/Future/Queue.pm000444001750001750 1626014545247010 16343 0ustar00leoleo000000000000# You may distribute under the terms of either the GNU General Public License # or the Artistic License (the same terms as Perl itself) # # (C) Paul Evans, 2019-2024 -- leonerd@leonerd.org.uk package Future::Queue 0.52; use v5.14; use warnings; use Carp; =head1 NAME C - a FIFO queue of values that uses Ls =head1 SYNOPSIS use Future::Queue; use Future::AsyncAwait; my $queue = Future::Queue->new; async sub process_queue { while(1) { my $thing = await $queue->shift; ... } } my $f = process_queue(); $queue->push( "a thing" ); =head1 DESCRIPTION Objects in this class provide a simple FIFO queue the stores arbitrary perl values. Values may be added into the queue using the L method, and retrieved from it using the L method. Values may be stored within the queue object for C to retrieve later, or if the queue is empty then the future that C returns will be completed once an item becomes available. =cut =head1 CONSTRUCTOR =cut =head2 new $queue = Future::Queue->new( %params ); Returns a new C instance. Takes the following named arguments: =over 4 =item max_items => INT I Optional. If defined, there can be at most the given number of items in the queue. Attempts to call L beyond that will yield a future that remains pending, until a subsequent L operation makes enough space. =item prototype => STRING or OBJECT or CODE I Optional. If defined, gives either a class name, an object instance to clone or a code reference to invoke when a new pending C instance is needed by the C or C methods when they cannot complete immediately. $f = $prototype->(); # if CODE reference $f = $prototype->new; # otherwise If not provided, a default of C will be used. =back =cut sub new { my $class = shift; my %params = @_; my $prototype = $params{prototype}; return bless { items => [], max_items => $params{max_items}, shift_waiters => [], ( ref $prototype eq "CODE" ) ? ( f_factory => $prototype ) : ( f_prototype => $prototype // "Future" ), }, $class; } =head2 push $queue->push( @items ); await $queue->push( @items ); Adds more items into the queue. If the queue was previously empty and there is at least one C future waiting, then the next one will be completed by this method. I this can take multiple items; earlier versions can only take one value at once. This method always returns a L instance. If C is defined then it is possible that this future will be in a still-pending state; indicating that there was not yet space in the queue to add the items. It will become completed once enough L calls have been made to make space for them. If C is not defined then these instances will always be immediately complete; it is safe to drop or ignore it, or call the method in void context. If the queue has been finished then more items cannot be pushed and an exception will be thrown. =cut sub _manage_shift_waiters { my $self = shift; my $items = $self->{items}; my $shift_waiters = $self->{shift_waiters}; ( shift @$shift_waiters )->() while @$shift_waiters and @$items; } sub push :method { my $self = shift; my @more = @_; $self->{finished} and croak "Cannot ->push more items to a Future::Queue that has been finished"; my $items = $self->{items}; my $max = $self->{max_items}; if( defined $max ) { my $count = $max - @$items; push @$items, splice @more, 0, $count; } else { push @$items, @more; @more = (); } $self->_manage_shift_waiters; return Future->done if !@more; my $f = $self->{f_factory} ? $self->{f_factory}->() : $self->{f_prototype}->new; push @{ $self->{push_waiters} //= [] }, sub { my $count = $max - @$items; push @$items, splice @more, 0, $count; $self->_manage_shift_waiters; return 0 if @more; $f->done; return 1; }; return $f; } =head2 shift $item = await $queue->shift; Returns a C that will yield the next item from the queue. If there is already an item then this will be taken and the returned future will be immediate. If not, then the returned future will be pending, and the next C method will complete it. If the queue has been finished then the future will yield an empty list, or C in scalar context. If C is a valid item in your queue, make sure to test this condition carefully. For example: while( ( my $item ) = await $queue->shift ) { ... } Here, the C expression and the assignment are in list context, so the loop will continue to iterate while I value is assigned, even if that value is C. The loop will only stop once no items are returned, indicating the end of the queue. =cut sub _manage_push_waiters { my $self = shift; my $items = $self->{items}; my $max_items = $self->{max_items}; my $push_waiters = $self->{push_waiters} || []; shift @$push_waiters while @$push_waiters and ( !defined $max_items or @$items < $max_items ) and $push_waiters->[0]->(); } sub shift :method { my $self = shift; my $items = $self->{items}; if( @$items ) { my @more = shift @$items; $self->_manage_push_waiters; return Future->done( @more ); } return Future->done if $self->{finished}; my $f = $self->{f_factory} ? $self->{f_factory}->() : $self->{f_prototype}->new; push @{ $self->{shift_waiters} }, sub { return $f->done if !@$items and $self->{finished}; $f->done( shift @$items ); $self->_manage_push_waiters; }; return $f; } =head2 shift_atmost @items = await $queue->shift_atmost( $count ); I A bulk version of L that can return multiple items at once. Returns a C that will yield the next few items from the queue. If there is already at least one item in the queue then up to C<$count> items will be taken, and the returned future will be immediate. If not, then the returned future will be pending and the next C method will complete it. =cut sub shift_atmost { my $self = shift; my ( $count ) = @_; my $items = $self->{items}; if( @$items ) { my @more = splice @$items, 0, $count; $self->_manage_push_waiters; return Future->done( @more ); } return Future->done if $self->{finished}; my $f = $self->{f_factory} ? $self->{f_factory}->() : $self->{f_prototype}->new; push @{ $self->{shift_waiters} }, sub { return $f->done if !@$items and $self->{finished}; $f->done( splice @$items, 0, $count ); $self->_manage_push_waiters; }; return $f; } =head2 finish $queue->finish; I Marks that the queue is now finished. Once the current list of items has been exhausted, any further attempts to C more will yield empty. =cut sub finish { my $self = shift; $self->{finished}++; ( shift @{ $self->{shift_waiters} } )->() while @{ $self->{shift_waiters} }; } =head1 AUTHOR Paul Evans =cut 0x55AA; Future-Queue-0.52/t000755001750001750 014545247010 12762 5ustar00leoleo000000000000Future-Queue-0.52/t/00use.t000444001750001750 17014545247010 14216 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; require Future::Queue; pass "Modules loaded"; done_testing; Future-Queue-0.52/t/01queue.t000444001750001750 114314545247010 14570 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; use Future; use Future::Queue; # push before shift { my $queue = Future::Queue->new; $queue->push( "ITEM" ); my $f = $queue->shift; ok( $f->is_done, '$queue->shift already ready' ); is( $f->result, "ITEM", '$queue->shift->result' ); } # shift before push { my $queue = Future::Queue->new; my $f = $queue->shift; ok( !$f->is_done, '$queue->shift not yet ready' ); $queue->push( "ITEM" ); ok( $f->is_done, '$queue->shift now ready after push' ); is( $f->result, "ITEM", '$queue->shift->result' ); } done_testing; Future-Queue-0.52/t/02max-items.t000444001750001750 146014545247010 15353 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; use Future; use Future::Queue; { my $queue = Future::Queue->new( max_items => 5 ); $queue->push( $_ ) for 1 .. 5; my $push_f = $queue->push( 6 ); ok( !$push_f->is_done, '$queue->push returned pending Future' ); my $shift_f = $queue->shift; ok( $push_f->is_done, 'push future now done after shift' ); } # RT151010 { my $queue = Future::Queue->new( max_items => 5 ); my @pushf = map { $queue->push( $_ ) } 'a' .. 'q'; # Should not spinlock in deep recursion my @shiftf = map { $queue->shift_atmost( 2 ) } 1 .. 9; is( [ map { $_->state } @pushf ], [ ("done") x 17 ], 'all push futures completed' ); is( [ map { $_->state } @shiftf ], [ ("done") x 9 ], 'all shift futures completed' ); } done_testing; Future-Queue-0.52/t/03finish.t000444001750001750 151114545247010 14725 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; use Future; use Future::Queue; # push before shift { my $queue = Future::Queue->new; $queue->push( "ITEM" ); $queue->finish; my $f1 = $queue->shift; my $f2 = $queue->shift; is( $f1->result, "ITEM", '$f1->result' ); is( [ $f2->result ], [], '$f2->result' ); ok( !defined eval { $queue->push( "MORE" ) }, '->push after ->finish is an error' ); like( $@, qr/^Cannot ->push more items to a Future::Queue that has been finished /, 'Exception from ->push after ->finish' ); } # shift before push { my $queue = Future::Queue->new; my $f1 = $queue->shift; my $f2 = $queue->shift; $queue->push( "ITEM" ); $queue->finish; is( $f1->result, "ITEM", '$f1->result' ); is( [ $f2->result ], [], '$f2->result' ); } done_testing; Future-Queue-0.52/t/04bulk.t000444001750001750 422414545247010 14407 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; use Future; use Future::Queue; # bulk-push before shift { my $queue = Future::Queue->new; $queue->push( qw( A B C ) ); is( $queue->shift->result, "A", 'shift 1' ); is( $queue->shift->result, "B", 'shift 2' ); is( $queue->shift->result, "C", 'shift 3' ); } # push before bulk-shift { my $queue = Future::Queue->new; $queue->push( $_ ) for qw( A B C D ); is( [ $queue->shift_atmost( 3 )->result ], [qw( A B C )], '->shift_atmost can yield multiple' ); is( [ $queue->shift_atmost( 3 )->result ], [qw( D )], '->shift_atmost yields when non-empty' ); ok( !$queue->shift_atmost( 3 )->is_ready, '->shift_atmost pending when empty' ); } # shift before bulk-push { my $queue = Future::Queue->new; my $f1 = $queue->shift; my $f2 = $queue->shift; my $f3 = $queue->shift; $queue->push( qw( A B C ) ); is( $f1->result, "A", 'shift 1' ); is( $f2->result, "B", 'shift 2' ); is( $f3->result, "C", 'shift 3' ); } # bulk-shift before push { my $queue = Future::Queue->new; my $f1 = $queue->shift_atmost( 3 ); my $f2 = $queue->shift_atmost( 3 ); $queue->push( $_ ) for qw( A B C ); is( [ $f1->result ], [qw( A )], 'shift_atmost yielded first pushed item' ); is( [ $f2->result ], [qw( B )], 'shift_atmost again yielded second pushed item' ); } # bulk-shift before bulk-push { my $queue = Future::Queue->new; my $f1 = $queue->shift_atmost( 3 ); my $f2 = $queue->shift_atmost( 3 ); $queue->push( qw( A B C D ) ); is( [ $f1->result ], [qw( A B C )], 'shift_atmost yielded first three pushed items' ); is( [ $f2->result ], [qw( D )], 'shift_atmost again yielded remaining pushed item' ); } # bulk-push with max_items { my $queue = Future::Queue->new( max_items => 3 ); my $push_f = $queue->push( qw( A B C D E ) ); ok( !$push_f->is_done, 'bulk push not yet ready while over-size' ); $queue->shift->result; ok( !$push_f->is_done, 'bulk push still not ready after first shift' ); $queue->shift->result; ok( $push_f->is_done, 'bulk push ready after second shift' ); } done_testing; Future-Queue-0.52/t/05prototype.t000444001750001750 140414545247010 15515 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; use Future; use Future::Queue; package t::Future::Subclass { use base qw( Future ); } # prototype is class name { my $queue = Future::Queue->new( prototype => "t::Future::Subclass" ); isa_ok( $queue->shift, [ "t::Future::Subclass" ], '->shift for prototype class' ); } # prototype is an instance { my $queue = Future::Queue->new( prototype => t::Future::Subclass->new ); isa_ok( $queue->shift, [ "t::Future::Subclass" ], '->shift for prototype object instance' ); } # prototype is a code ref { my $queue = Future::Queue->new( prototype => sub { t::Future::Subclass->new } ); isa_ok( $queue->shift, [ "t::Future::Subclass" ], '->shift for prototype object instance' ); } done_testing; Future-Queue-0.52/t/99pod.t000444001750001750 25514545247010 14232 0ustar00leoleo000000000000#!/usr/bin/perl use v5.14; use warnings; use Test2::V0; eval "use Test::Pod 1.00"; plan skip_all => "Test::Pod 1.00 required for testing POD" if $@; all_pod_files_ok();