Debian Codegraph @

upstream/debian-unstable/man3/TAP::Parser::Scheduler::Job.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::Job 3perl"
58 .TH TAP::Parser::Scheduler::Job 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::Job \- A single testing 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::Job;
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 Represents a single test 'job'.
76 .SH METHODS
77 .IX Header "METHODS"
78 .SS "Class Methods"
79 .IX Subsection "Class Methods"
80 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
81 .IX Subsection "new"
82 .PP
83 .Vb 3
84 \& my $job = TAP::Parser::Scheduler::Job\->new(
85 \& $filename, $description
86 \& );
87 .Ve
88 .PP
89 Given the filename and description of a test as scalars, returns a new
90 TAP::Parser::Scheduler::Job object.
91 .SS "Instance Methods"
92 .IX Subsection "Instance Methods"
93 \fR\f(CI\*(C`on_finish\*(C'\fR\fI\fR
94 .IX Subsection "on_finish"
95 .PP
96 .Vb 1
97 \& $self\->on_finish(\e&method).
98 .Ve
99 .PP
100 Register a closure to be called when this job is destroyed. The callback
101 will be passed the \f(CW\*(C`TAP::Parser::Scheduler::Job\*(C'\fR object as it's only argument.
102 .PP
103 \fR\f(CI\*(C`finish\*(C'\fR\fI\fR
104 .IX Subsection "finish"
105 .PP
106 .Vb 1
107 \& $self\->finish;
108 .Ve
109 .PP
110 Called when a job is complete to unlock it. If a callback has been registered
111 with \f(CW\*(C`on_finish\*(C'\fR, it calls it. Otherwise, it does nothing.
112 .SS Attributes
113 .IX Subsection "Attributes"
114 .Vb 3
115 \& $self\->filename;
116 \& $self\->description;
117 \& $self\->context;
118 .Ve
119 .PP
120 These are all "getters" which return the data set for these attributes during object construction.
121 .PP
122 \fR\f(CI\*(C`filename\*(C'\fR\fI\fR
123 .IX Subsection "filename"
124 .PP
125 \fR\f(CI\*(C`description\*(C'\fR\fI\fR
126 .IX Subsection "description"
127 .PP
128 \fR\f(CI\*(C`context\*(C'\fR\fI\fR
129 .IX Subsection "context"
130 .PP
131 \fR\f(CI\*(C`as_array_ref\*(C'\fR\fI\fR
132 .IX Subsection "as_array_ref"
133 .PP
134 For backwards compatibility in callbacks.
135 .PP
136 \fR\f(CI\*(C`is_spinner\*(C'\fR\fI\fR
137 .IX Subsection "is_spinner"
138 .PP
139 .Vb 1
140 \& $self\->is_spinner;
141 .Ve
142 .PP
143 Returns false indicating that this is a real job rather than a
144 \&'spinner'. Spinners are returned when the scheduler still has pending
145 jobs but can't (because of locking) return one right now.