/usr/share/perl5/Net/Hotline/Task.pod is in libnet-hotline-perl 0.83-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | =head1 NAME
Net::Hotline::Task - Task object used internally by Net::Hotline::Client
=head1 SYNOPSIS
use Net::Hotline::Task;
$task = new Net::Hotline::Task;
$task->start(time());
$task->num($num++);
...
=head1 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.
=head1 CONSTRUCTION
=over 4
=item 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.
=back
=head1 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.
=over 4
=item error EXPR
The error state of the task. A true value means there was an error.
=item error_text TEXT
The error message text. This only applies if error() returns a true value.
=item finish TIME
The time (in platform-native time format, i.e. seconds since the epoch
on a Unix system) that a task completed.
=item num NUMBER
The unique task number. Task numbers increase sequentially.
=item 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.
=item socket NUMBER
The unique user socket number associated with a task (if any).
=item start TIME
The time (in platform-native time format) that a task was started.
=item 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.
=back
=head1 AUTHOR
John C. Siracusa (siracusa@mindspring.com)
=head1 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.
|