net::hotline::task(3pm) [debian man page]
Net::Hotline::Task(3pm) User Contributed Perl Documentation Net::Hotline::Task(3pm) NAME
Net::Hotline::Task - Task object used internally by Net::Hotline::Client SYNOPSIS
use Net::Hotline::Task; $task = new Net::Hotline::Task; $task->start(time()); $task->num($num++); ... DESCRIPTION
Net::Hotline::Task is a simple class for storing and retrieving task information, You should never have to create your own Net::Hotline::Task objects when using Net::Hotline::Client. Getting and (to a lesser extent) setting attributes is all that should be necessary. CONSTRUCTION
new NUM, TYPE, START, SOCKET, PATH With no arguments, creates a new Net::Hotline::Task object with all attributes set to undef. With three or four arguments (PATH is optional), creates a new Net::Hotline::Task object with task number NUM, task type TYPE, start time START, user socket number SOCKET, and file path PATH. METHODS
All the Net::Hotline::Task methods are simple attribute get/set routines. If given an argument, they set an attribute. In all cases, they return the current value of the attribute. error EXPR The error state of the task. A true value means there was an error. error_text TEXT The error message text. This only applies if error() returns a true value. finish TIME The time (in platform-native time format, i.e. seconds since the epoch on a Unix system) that a task completed. num NUMBER The unique task number. Task numbers increase sequentially. path PATH The path information associated with a task (if any). In situations where two paths may be associated with a task (a "move file" task, for example), a reference to an array containing the paths will be returned. socket NUMBER The unique user socket number associated with a task (if any). start TIME The time (in platform-native time format) that a task was started. type TASK_TYPE The HTLC_TASK_XXX constant specifying the type of task. These constants are defined in Net::Hotline::Constants, and include: HTLC_TASK_KICK Disconnect a user. HTLC_TASK_LOGIN Log into server. HTLC_TASK_NEWS Get the news. HTLC_TASK_NEWS_POST Post to news. HTLC_TASK_FILE_DELETE Delete a file. HTLC_TASK_FILE_INFO Get file information. HTLC_TASK_FILE_LIST Get a file list. HTLC_TASK_FILE_MKDIR Create a new folder. HTLC_TASK_FILE_MOVE Move a file. HTLC_TASK_SEND_MSG Send a private message. HTLC_TASK_SET_INFO Set file information. HTLC_TASK_USER_INFO Get user information. HTLC_TASK_USER_LIST Get the userlist. AUTHOR
John C. Siracusa (siracusa@mindspring.com) COPYRIGHT
Copyright(c) 1999 by John Siracusa. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. perl v5.10.1 2002-11-27 Net::Hotline::Task(3pm)
Check Out this Related Man Page
Gearman::Task(3pm) User Contributed Perl Documentation Gearman::Task(3pm) NAME
Gearman::Task - a task in Gearman, from the point of view of a client SYNOPSIS
my $task = Gearman::Task->new("add", "1+2", { ..... }; $taskset->add_task($task); $client->do_task($task); $client->dispatch_background($task); DESCRIPTION
Gearman::Task is a Gearman::Client's representation of a task to be done. USAGE
Gearman::Task->new($func, $arg, \%options) Creates a new Gearman::Task object, and returns the object. $func is the function name to be run. (that you have a worker registered to process) $arg is an opaque scalar or scalarref representing the argument(s) to pass to the distributed function. If you want to pass multiple arguments, you must encode them somehow into this one. That's up to you and your worker. %options can contain: o uniq A key which indicates to the server that other tasks with the same function name and key will be merged into one. That is, the task will be run just once, but all the listeners waiting on that job will get the response multiplexed back to them. Uniq may also contain the magic value "-" (a single hyphen) which means the uniq key is the contents of the args. o on_complete A subroutine reference to be invoked when the task is completed. The subroutine will be passed a reference to the return value from the worker process. o on_fail A subroutine reference to be invoked when the task fails (or fails for the last time, if retries were specified). No arguments are passed to this callback. This callback won't be called after a failure if more retries are still possible. o on_retry A subroutine reference to be invoked when the task fails, but is about to be retried. Is passed one argument, what retry attempt number this is. (starts with 1) o on_status A subroutine reference to be invoked if the task emits status updates. Arguments passed to the subref are ($numerator, $denominator), where those are left up to the client and job to determine. o retry_count Number of times job will be retried if there are failures. Defaults to 0. o high_priority Boolean, whether this job should take priority over other jobs already enqueued. o timeout Automatically fail, calling your on_fail callback, after this many seconds have elapsed without an on_fail or on_complete being called. Defaults to 0, which means never. Bypasses any retry_count remaining. o try_timeout Automatically fail, calling your on_retry callback (or on_fail if out of retries), after this many seconds have elapsed. Defaults to 0, which means never. $task->is_finished Returns bool: whether or not task is totally done (on_failure or on_complete callback has been called) perl v5.10.1 2009-10-05 Gearman::Task(3pm)