NAME

Test2::Harness::Util::Queue - Representation of a queue.

DESCRIPTION

This module represents a queue, stored as a jsonl file.

SYNOPSIS

    use Test2::Harness::Util::Queue;
    my $queue = Test2::Harness::Util::Queue->new(file => '/path/to/queue.jsonl');
    $queue->start(); # Create the queue
    $queue->enqueue({foo => 'bar', baz => 'bat'});
    $queue->enqueue({foo => 'bar2', baz => 'bat2'});
    ...
    $queue->end();

Then in another processs:

    use Test2::Harness::Util::Queue;
    my $queue = Test2::Harness::Util::Queue->new(file => '/path/to/queue.jsonl');
    my @items;
    while (1) {
        @items = $queue->poll();
        while (@items) {
            my $item = shift @items or last;
            ... process $item
        }
        # Queue ends with an 'undef' entry
        last if @items && !defined($items[0]);
    }

METHODS

$path = $queue->file

The filename used for the queue

WRITING

$queue->start()

Open the queue file for writing.

$queue->enqueue(\%HASHREF)

Add an item to the queue.

$queue->end()

Terminate the queue.

SOURCE

The source code repository for Test2-Harness can be found at http://github.com/Test-More/Test2-Harness/.

MAINTAINERS

Chad Granum <exodist@cpan.org>

AUTHORS

Chad Granum <exodist@cpan.org>

COPYRIGHT

Copyright 2020 Chad Granum <exodist7@gmail.com>.

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

See http://dev.perl.org/licenses/