view release on metacpan or  search on metacpan

lib/Async/Trampoline/Scheduler.pm  view on Meta::CPAN

use strict;
use warnings;
use utf8;

package Async::Trampoline::Scheduler;

## no critic
our $VERSION = '0.001002';  # VERSION
$VERSION = eval $VERSION;
## use critic

use XSLoader;
XSLoader::load __PACKAGE__, $VERSION;

1;

__END__

=head1 NAME

Async::Trampoline::Scheduler - decide which thunk should be evaluated next

=head1 DESCRIPTION

This is an B<internal module>.
The interface may change at any time.

=head2 new

    $scheduler = Async::Trampoline::Scheduler->new

Create a new scheduler.

=head2 enqueue

    $scheduler->enqueue($task)

    $scheduler->enqueue($task => @blocked)

Add a I<$task> to the runnable queue.

B<$task>:
A task to be scheduled at some point in the future.

B<@blocked>:
Any number of tasks that depend on the I<$task>.
The blocked tasks will be added to the runnable queue
once the I<$task> is completed.

=head2 dequeue

    ($task) = $scheduler->dequeue
    ()      = $scheduler->dequeue

Get the next scheduled I<$task>.

B<returns>:
A I<$task> if there is a runnable task.
An empty list if no tasks are runnable.

=head2 complete

    $scheduler->complete($task)

Mark a I<$task> as completed.

This may move further tasks to the runnable state.

B<$task>:
A task that was completed.

=cut