Debian Codegraph @

upstream/debian-unstable/man3/TAP::Parser::Scheduler::Spinner.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "TAP::Parser::Scheduler::Spinner 3perl"
58 .TH TAP::Parser::Scheduler::Spinner 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 TAP::Parser::Scheduler::Spinner \- A no\-op job.
65 .SH VERSION
66 .IX Header "VERSION"
67 Version 3.48
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use TAP::Parser::Scheduler::Spinner;
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 A no-op job. Returned by \f(CW\*(C`TAP::Parser::Scheduler\*(C'\fR as an instruction to
76 the harness to spin (keep executing tests) while the scheduler can't
77 return a real job.
78 .SH METHODS
79 .IX Header "METHODS"
80 .SS "Class Methods"
81 .IX Subsection "Class Methods"
82 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
83 .IX Subsection "new"
84 .PP
85 .Vb 1
86 \& my $job = TAP::Parser::Scheduler::Spinner\->new;
87 .Ve
88 .PP
89 Ignores any arguments and returns a new \f(CW\*(C`TAP::Parser::Scheduler::Spinner\*(C'\fR object.
90 .SS "Instance Methods"
91 .IX Subsection "Instance Methods"
92 \fR\f(CI\*(C`is_spinner\*(C'\fR\fI\fR
93 .IX Subsection "is_spinner"
94 .PP
95 Returns true indicating that is a 'spinner' job. Spinners are returned
96 when the scheduler still has pending jobs but can't (because of locking)
97 return one right now.
98 .SH "SEE ALSO"
99 .IX Header "SEE ALSO"
100 TAP::Parser::Scheduler, TAP::Parser::Scheduler::Job