Event::ExecFlow::Job (3)

Leading comments

Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Event::ExecFlow::Job.3pm".)

NAME

Event::ExecFlow::Job - Abstract base class for all job classes

SYNOPSIS

  Event::ExecFlow::Job->new (
    title                => Descriptive title,
    name                 => Internal short name,
    depends_on           => Names of jobs, this job depends on,
    progress_max         => Maximum expected progress value,
    progress_ips         => String to show as "items per second",
    no_progress          => Job has no progress state at all,
    pre_callbacks        => Callbacks executed before job starts,
    post_callbacks       => Callbacks executed after job finished,
    error_callbacks      => Callbacks executed if job had errors,
    warning_callbacks    => Callbacks executed if job had warnings,
    stash                => A custom data hash stored with the job,
  );

DESCRIPTION

This is an abstract base class and usually not used directly from the application. For daily programming the attributes defined in this class are most important, since they are common to all Jobs of the Event::ExecFlow framework.

OBJECT HIERARCHY

  Event::ExecFlow

  Event::ExecFlow::Job
  +--- Event::ExecFlow::Job::Group
  +--- Event::ExecFlow::Job::Command
  +--- Event::ExecFlow::Job::Code

  Event::ExecFlow::Frontend
  Event::ExecFlow::Callbacks
  Event::ExecFlow::Scheduler
  +--- Event::ExecFlow::Scheduler::SimpleMax

ATTRIBUTES

Attributes may be set with the new() constructor passed as a hash and accessed at runtime using the common get_ATTR(), set_ATTR() style accessors.

[

describe all attributes in detail ]

METHODS

[ describe all methods in detail ]

AUTHORS

 Jo.rn Reder <joern at zyn dot de>

COPYRIGHT AND LICENSE

Copyright 2005-2006 by Jo.rn Reder.

This library is free software; you can redistribute it and/or modify it under the terms of the

Library General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but

; without even the implied warranty of or A . See the Library General Public License for more details.

You should have received a copy of the

Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, 02111-1307 .