Net::Hotline::Task (3pm)

    use Net::Hotline::Task;

    $task = new Net::Hotline::Task;

    $task->start(time());
    $task->num($num++);
    ...

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.

new \s-1NUM\s0, \s-1TYPE\s0, \s-1START\s0, \s-1SOCKET\s0, \s-1PATH\s0

With no arguments, creates a new Net::Hotline::Task object with all attributes set to undef. With three or four arguments (\s-1PATH\s0 is optional), creates a new Net::Hotline::Task object with task number \s-1NUM\s0, task type \s-1TYPE\s0, start time \s-1START\s0, user socket number \s-1SOCKET\s0, and file path \s-1PATH\s0.

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 \s-1EXPR\s0

The error state of the task. A true value means there was an error.

error_text \s-1TEXT\s0

The error message text. This only applies if error() returns a true value.

finish \s-1TIME\s0

The time (in platform-native time format, i.e. seconds since the epoch on a Unix system) that a task completed.

num \s-1NUMBER\s0

The unique task number. Task numbers increase sequentially.

path \s-1PATH\s0

The path information associated with a task (if any). In situations where two paths may be associated with a task (a \*(L"move file\*(R" task, for example), a reference to an array containing the paths will be returned.

socket \s-1NUMBER\s0

The unique user socket number associated with a task (if any).

start \s-1TIME\s0

The time (in platform-native time format) that a task was started.

type \s-1TASK_TYPE\s0

The \s-1HTLC_TASK_XXX\s0 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.

John C. Siracusa ([email protected])

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.