.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TAP::Parser::Scheduler::Job 3perl"
.TH TAP::Parser::Scheduler::Job 3perl 2024-09-01 "perl v5.40.0" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
TAP::Parser::Scheduler::Job \- A single testing job.
.SH VERSION
.IX Header "VERSION"
Version 3.48
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use TAP::Parser::Scheduler::Job;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Represents a single test 'job'.
.SH METHODS
.IX Header "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fR\f(CI\*(C`new\*(C'\fR\fI\fR
.IX Subsection "new"
.PP
.Vb 3
\&    my $job = TAP::Parser::Scheduler::Job\->new(
\&        $filename, $description
\&    );
.Ve
.PP
Given the filename and description of a test as scalars, returns a new
TAP::Parser::Scheduler::Job object.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fR\f(CI\*(C`on_finish\*(C'\fR\fI\fR
.IX Subsection "on_finish"
.PP
.Vb 1
\&    $self\->on_finish(\e&method).
.Ve
.PP
Register a closure to be called when this job is destroyed. The callback
will be passed the \f(CW\*(C`TAP::Parser::Scheduler::Job\*(C'\fR object as it's only argument.
.PP
\fR\f(CI\*(C`finish\*(C'\fR\fI\fR
.IX Subsection "finish"
.PP
.Vb 1
\&   $self\->finish;
.Ve
.PP
Called when a job is complete to unlock it. If a callback has been registered
with \f(CW\*(C`on_finish\*(C'\fR, it calls it. Otherwise, it does nothing.
.SS Attributes
.IX Subsection "Attributes"
.Vb 3
\&  $self\->filename;
\&  $self\->description;
\&  $self\->context;
.Ve
.PP
These are all "getters" which return the data set for these attributes during object construction.
.PP
\fR\f(CI\*(C`filename\*(C'\fR\fI\fR
.IX Subsection "filename"
.PP
\fR\f(CI\*(C`description\*(C'\fR\fI\fR
.IX Subsection "description"
.PP
\fR\f(CI\*(C`context\*(C'\fR\fI\fR
.IX Subsection "context"
.PP
\fR\f(CI\*(C`as_array_ref\*(C'\fR\fI\fR
.IX Subsection "as_array_ref"
.PP
For backwards compatibility in callbacks.
.PP
\fR\f(CI\*(C`is_spinner\*(C'\fR\fI\fR
.IX Subsection "is_spinner"
.PP
.Vb 1
\&  $self\->is_spinner;
.Ve
.PP
Returns false indicating that this is a real job rather than a
\&'spinner'. Spinners are returned when the scheduler still has pending
jobs but can't (because of locking) return one right now.