Net::Cmd - Network Command class |
Net::Cmd - Network Command class (as used by FTP, SMTP etc)
use Net::Cmd;
@ISA = qw(Net::Cmd);
Net::Cmd
is a collection of methods that can be inherited by a sub class
of IO::Handle
. These methods implement the functionality required for a
command based protocol, for example FTP and SMTP.
These methods provide a user interface to the Net::Cmd
object.
VALUE
is not given
then the current state is returned. Otherwise the state is changed to
VALUE
and the previous state returned.
Different packages may implement different levels of debug but a non-zero value results in copies of all commands and responses also being sent to STDERR.
If VALUE
is undef
then the debug level will be set to the default
debug level for the class.
This method can also be called as a static method to set/get the default debug level for a given class.
CMD_PENDING
is returned.
DATA
may be an array or a reference to an array.
dataend
calls response
and
returns true if response
returns CMD_OK.
These methods are not intended to be called by the user, but used or
over-ridden by a sub-class of Net::Cmd
DIR
denotes the direction true being
data being sent to the server. Calls debug_text
before printing to
STDERR.
This is primarily meant for the use of modules such as FTP where passwords are sent, but we do not want to display them in the debugging information.
Returns undef upon failure
response
as a method with one argument. It should
return an array of 2 values, the 3-digit status code and a flag which is true
when this is part of a multi-line response and this line is not the list.
NOTE: If you do use this method for any reason, please remember to add
some debug_print
calls into your method.
Returns a reference to a list containing the lines, or undef upon failure.
read()
or <>. The
filehandle will return EOF when the final dot is encountered.
Similarly, you may write to the filehandle in order to send data to
the server after issuing a commmand that expects data to be written.
See the Net::POP3 and Net::SMTP modules for examples of this.
Net::Cmd
exports six subroutines, five of these, CMD_INFO
, CMD_OK
,
CMD_MORE
, CMD_REJECT
and CMD_ERROR
, correspond to possible results
of response
and status
. The sixth is CMD_PENDING
.
Graham Barr <gbarr@pobox.com>
Copyright (c) 1995-1997 Graham Barr. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
$Id: //depot/libnet/Net/Cmd.pm#28 $
Net::Cmd - Network Command class |