NAME

Minion::Iterator - Minion iterator

SYNOPSIS

  use Minion::Iterator;

  my $iter = Minion::Iterator->new(minion  => $minion, options => {states => ['inactive']});

DESCRIPTION

Minion::Iterator is an iterator for Minion listing methods.

ATTRIBUTES

Minion::Iterator implements the following attributes.

fetch

  my $fetch = $iter->fetch;
  $iter     = $iter->fetch(2);

Number of results to cache, defaults to 10.

minion

  my $minion = $iter->minion;
  $iter      = $iter->minion(Minion->new);

Minion object this job belongs to.

options

  my $options = $iter->options;
  $iter       = $iter->options({states => ['inactive']});

Options to be passed to "list_jobs" in Minion::Backend or "list_workers" in Minion::Backend.

METHODS

Minion::Iterator inherits all methods from Mojo::Base and implements the following new ones.

next

  my $value = $iter->next;

Get next value.

total

  my $num = $iter->total;

Total number of results. If results are removed in the backend while iterating, this number will become an estimate that gets updated every time new results are fetched.

SEE ALSO

Minion, https://minion.pm, Mojolicious::Guides, https://mojolicious.org.