Christian-Rolf Grün > Catalyst-Engine-JobQueue-POE > Catalyst::JobQueue::Job

Download:
Catalyst-Engine-JobQueue-POE-0.0.4.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.0.1   Source  

NAME ^

Catalyst::JobQueue::Job - Catalyst request to be run by a JobQueue Engine

VERSION ^

This document describes Catalyst::JobQueue::Job version 0.0.1

SYNOPSIS ^

  my $job = $c->engine->get_job($id);

  my $jobid = $job->ID;

DESCRIPTION ^

This object represents a job (i.e. the data needed to build a JobQueue request). Jobs are created by the engine from various sources. Please do not attempt to instantiate a job object directly.

Job Data

Each job object has an ID (currently this is the refaddr of the hash used to store job data), a set of flags (to signal various stages of job processing) as well as job type specific data.

INTERFACE ^

new( \%attr )

Constructs a new job object. Constructor parameters depend on the job type. ID and flags are filled in automatically.

cleanup

Clear temporary data, preparing the job for a new run through the engine.

ID

The ID of the job.

cronspec

The cronspec string which determines when the job will run.

user

The user as which the job is to be run. UNUSED.

request

An array which holds request data. The first element is the request path, the rest are query arguments (in the form of param_name=param_value).

last_status

The status code of the last run of the job.

context

Holds a reference to the current context object.

env

Holds a reference to the environment hash through which request data is passed to the engine (CGI-style)

flags

A set of flags used by the engine in request processing.

scheduler

A reference to the job's cron scheduler.

CONFIGURATION AND ENVIRONMENT ^

Catalyst::JobQueue::Job requires no configuration files or environment variables.

DEPENDENCIES ^

Class::Accessor::Fast.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-catalyst-jobqueue-job@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

Gruen Christian-Rolf <kiki@bsdro.org>

LICENCE AND COPYRIGHT ^

Copyright (c) 2006, Gruen Christian-Rolf <kiki@abc.ro>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.n 1;

syntax highlighting: