.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::Hotline::Task 3pm"
.TH Net::Hotline::Task 3pm "2021-01-09" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::Hotline::Task \- Task object used internally by Net::Hotline::Client
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Net::Hotline::Task;
\&
\&    $task = new Net::Hotline::Task;
\&
\&    $task\->start(time());
\&    $task\->num($num++);
\&    ...
.Ve
.SH "DESCRIPTION"
.IX Header "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.
.SH "CONSTRUCTION"
.IX Header "CONSTRUCTION"
.IP "new \s-1NUM, TYPE, START, SOCKET, PATH\s0" 4
.IX 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 (\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
.SH "METHODS"
.IX Header "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.
.IP "error \s-1EXPR\s0" 4
.IX Item "error EXPR"
The error state of the task.  A true value means there was an error.
.IP "error_text \s-1TEXT\s0" 4
.IX Item "error_text TEXT"
The error message text.  This only applies if \fBerror()\fR returns a true value.
.IP "finish \s-1TIME\s0" 4
.IX Item "finish TIME"
The time (in platform-native time format, i.e. seconds since the epoch
on a Unix system) that a task completed.
.IP "num \s-1NUMBER\s0" 4
.IX Item "num NUMBER"
The unique task number.  Task numbers increase sequentially.
.IP "path \s-1PATH\s0" 4
.IX Item "path PATH"
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.
.IP "socket \s-1NUMBER\s0" 4
.IX Item "socket NUMBER"
The unique user socket number associated with a task (if any).
.IP "start \s-1TIME\s0" 4
.IX Item "start TIME"
The time (in platform-native time format) that a task was started.
.IP "type \s-1TASK_TYPE\s0" 4
.IX Item "type TASK_TYPE"
The \s-1HTLC_TASK_XXX\s0 constant specifying the type of task.  These constants
are defined in Net::Hotline::Constants, and include:
.Sp
.Vb 10
\&    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.
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
John C. Siracusa (siracusa@mindspring.com)
.SH "COPYRIGHT"
.IX Header "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.