Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

TAP::Parser::Scheduler::Job (3)

Name

TAP::Parser::Scheduler::Job - A single testing job.

Synopsis

use TAP::Parser::Scheduler::Job;

Description

Perl Programmers Reference Guide
                                                TAP::Parser::Scheduler::Job(3)



NAME
       TAP::Parser::Scheduler::Job - A single testing job.

VERSION
       Version 3.42

SYNOPSIS
           use TAP::Parser::Scheduler::Job;

DESCRIPTION
       Represents a single test 'job'.

METHODS
   Class Methods
       "new"

           my $job = TAP::Parser::Scheduler::Job->new(
               $filename, $description
           );

       Given the filename and description of a test as scalars, returns a new
       TAP::Parser::Scheduler::Job object.

   Instance Methods
       "on_finish"

           $self->on_finish(\&method).

       Register a closure to be called when this job is destroyed. The
       callback will be passed the "TAP::Parser::Scheduler::Job" object as
       it's only argument.

       "finish"

          $self->finish;

       Called when a job is complete to unlock it. If a callback has been
       registered with "on_finish", it calls it. Otherwise, it does nothing.

   Attributes
         $self->filename;
         $self->description;
         $self->context;

       These are all "getters" which return the data set for these attributes
       during object construction.

       "filename"

       "description"

       "context"

       "as_array_ref"

       For backwards compatibility in callbacks.

       "is_spinner"

         $self->is_spinner;

       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.



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | runtime/perl-532      |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

NOTES
       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.perl.org/.



perl v5.32.0                      2020-06-14
                                                TAP::Parser::Scheduler::Job(3)