The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
IO-Iron-0.12
River stage one • 2 direct dependents • 2 total dependents
++
/ IO::Iron::IronWorker::Task

NAME

IO::Iron::IronWorker::Task - IronWorker (Online Worker Platform) Client (Task).

SYNOPSIS

Please see IO::Iron::IronWorker::Client for usage.

REQUIREMENTS

SUBROUTINES/METHODS

new

Creator function.

Getters/setters

Set or get a property. When setting, returns the reference to the object.

code_name, The name of the code package to execute for this task (mandatory).
payload, A string of data to be passed to the worker (usually JSON), can be empty (mandatory).
priority, The priority queue to run the task in. Valid values are 0, 1, and 2. 0 is the default.
timeout, The maximum runtime of your task in seconds.
delay, The number of seconds to delay before actually queuing the task. Default is 0.
name, Name of task or scheduled task.
These are for scheduled task:
run_every, The amount of time, in seconds, between runs
end_at, The time tasks will stop being queued. Should be a time or a full timestamp (date and time).
run_times, The number of times a task will run.
start_at, The time the scheduled task should first be run.
Returned when queried a queued task:
id, Task or Scheduled task id.
project_id, Iron.io project ID.
code_id, The code package id.
status, Task execution status.
code_history_id, Code package revision id?
code_rev, Code package revision number.
start_time, Execution started?
end_time, Execution finished?
duration, Execution duration?
updated_at, Timestamp (ISO) of last update.
created_at, Timestamp (ISO) of creation. E.g. "2012-11-10T18:31:08.064Z"

log

Params: [none]
Return: task log (text/plain).
Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

Return the task's log (task's STDOUT).

cancel

Params: [none]
Return: 1 if successful.
Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

Cancel a task.

set_progress

Params (in params hash): percent (integer), msg (free text)
Return: 1 if successful.
Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

Set the progress info to the task.

retry

Params: delay (number of seconds before the task is queued again)
Return: new task id if successful.
Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

Retry a task. A new task id is updated to id field of the object. The id is also returned.

cancel_scheduled

Params: [none]
Return: 1 if successful.
Exception: IronHTTPCallException if fails. (IronHTTPCallException: status_code=<HTTP status code> response_message=<response_message>)

Cancel a task.

AUTHOR

Mikko Koivunalho, <mikko.koivunalho at iki.fi>

BUGS

Please report any bugs or feature requests to bug-io-iron at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=IO-Iron. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc IO::Iron::IronMQ

You can also look for information at:

ACKNOWLEDGMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Mikko Koivunalho.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.