xref: /openbsd-src/gnu/usr.bin/perl/cpan/Test-Harness/lib/TAP/Parser/Scheduler/Spinner.pm (revision d13be5d47e4149db2549a9828e244d59dbc43f15)
1package TAP::Parser::Scheduler::Spinner;
2
3use strict;
4use vars qw($VERSION);
5use Carp;
6
7=head1 NAME
8
9TAP::Parser::Scheduler::Spinner - A no-op job.
10
11=head1 VERSION
12
13Version 3.17
14
15=cut
16
17$VERSION = '3.17';
18
19=head1 SYNOPSIS
20
21    use TAP::Parser::Scheduler::Spinner;
22
23=head1 DESCRIPTION
24
25A no-op job. Returned by C<TAP::Parser::Scheduler> as an instruction to
26the harness to spin (keep executing tests) while the scheduler can't
27return a real job.
28
29=head1 METHODS
30
31=head2 Class Methods
32
33=head3 C<new>
34
35    my $job = TAP::Parser::Scheduler::Spinner->new;
36
37Returns a new C<TAP::Parser::Scheduler::Spinner> object.
38
39=cut
40
41sub new { bless {}, shift }
42
43=head3 C<is_spinner>
44
45Returns true indicating that is a 'spinner' job. Spinners are returned
46when the scheduler still has pending jobs but can't (because of locking)
47return one right now.
48
49=cut
50
51sub is_spinner {1}
52
531;
54