Commit | Line | Data |
3fea05b9 |
1 | package TAP::Parser::Scheduler::Spinner; |
2 | |
3 | use strict; |
4 | use vars qw($VERSION); |
5 | use Carp; |
6 | |
7 | =head1 NAME |
8 | |
9 | TAP::Parser::Scheduler::Spinner - A no-op job. |
10 | |
11 | =head1 VERSION |
12 | |
13 | Version 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 | |
25 | A no-op job. Returned by C<TAP::Parser::Scheduler> as an instruction to |
26 | the harness to spin (keep executing tests) while the scheduler can't |
27 | return 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 | |
37 | Returns a new C<TAP::Parser::Scheduler::Spinner> object. |
38 | |
39 | =cut |
40 | |
41 | sub new { bless {}, shift } |
42 | |
43 | =head3 C<is_spinner> |
44 | |
45 | Returns true indicating that is a 'spinner' job. Spinners are returned |
46 | when the scheduler still has pending jobs but can't (because of locking) |
47 | return one right now. |
48 | |
49 | =cut |
50 | |
51 | sub is_spinner {1} |
52 | |
53 | 1; |