InfoSys::FreeDB::Response::SignOn - FreeDB sign-on response
This class is used internally by the InfoSys::FreeDB::Connection::CDDBP class.
InfoSys::FreeDB::Connection::CDDBP
FreeDB sign-on response
InfoSys::FreeDB::Response::SignOn contains information about FreeDB sign-on responses.
InfoSys::FreeDB::Response::SignOn
Creates a new InfoSys::FreeDB::Response::SignOn object. OPT_HASH_REF is a hash reference used to pass initialization options. OPT_HASH_REF is mandatory. On error an exception Error::Simple is thrown.
OPT_HASH_REF
Error::Simple
Options for OPT_HASH_REF may include:
connection_allowed
Passed to set_connection_allowed(). Defaults to 1.
date
Passed to set_date().
hostname
Passed to set_hostname().
read_allowed
Passed to set_read_allowed(). Defaults to 1.
version
Passed to set_version().
write_allowed
Passed to set_write_allowed(). Defaults to 1.
Options for OPT_HASH_REF inherited through package InfoSys::FreeDB::Response may include:
InfoSys::FreeDB::Response
code
Passed to set_code(). Mandatory option.
error
Passed to set_error().
result
Passed to set_result(). Mandatory option.
Creates a new InfoSys::FreeDB::Response::SignOn object from the specified content reference. CONTENT_REF is a string reference. On error an exception Error::Simple is thrown.
CONTENT_REF
This method is inherited from package InfoSys::FreeDB::Response. Returns the response code.
Returns the current date and time.
Returns the server host name.
This method is inherited from package InfoSys::FreeDB::Response. Returns the response result text.
Returns the version number of server software.
Returns whether connecting is allowed or not.
This method is inherited from package InfoSys::FreeDB::Response. Returns whether the response has an error or not.
Returns whether reading is allowed or not.
Returns whether writing is allowed or not.
This method is inherited from package InfoSys::FreeDB::Response. Set the response code. VALUE is the value. On error an exception Error::Simple is thrown.
VALUE
State that connecting is allowed. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.
1
Set the current date and time. VALUE is the value. On error an exception Error::Simple is thrown.
This method is inherited from package InfoSys::FreeDB::Response. State that the response has an error. VALUE is the value. On error an exception Error::Simple is thrown.
Set the server host name. VALUE is the value. On error an exception Error::Simple is thrown.
State that reading is allowed. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.
This method is inherited from package InfoSys::FreeDB::Response. Set the response result text. VALUE is the value. On error an exception Error::Simple is thrown.
Set the version number of server software. VALUE is the value. On error an exception Error::Simple is thrown.
State that writing is allowed. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.
InfoSys::FreeDB, InfoSys::FreeDB::Connection, InfoSys::FreeDB::Connection::CDDBP, InfoSys::FreeDB::Connection::HTTP, InfoSys::FreeDB::Entry, InfoSys::FreeDB::Entry::Track, InfoSys::FreeDB::Match, InfoSys::FreeDB::Response, InfoSys::FreeDB::Response::DiscId, InfoSys::FreeDB::Response::Hello, InfoSys::FreeDB::Response::LsCat, InfoSys::FreeDB::Response::Motd, InfoSys::FreeDB::Response::Proto, InfoSys::FreeDB::Response::Query, InfoSys::FreeDB::Response::Quit, InfoSys::FreeDB::Response::Read, InfoSys::FreeDB::Response::Sites, InfoSys::FreeDB::Response::Stat, InfoSys::FreeDB::Response::Ver, InfoSys::FreeDB::Response::Whom, InfoSys::FreeDB::Response::Write::1, InfoSys::FreeDB::Response::Write::2, InfoSys::FreeDB::Site
None known (yet.)
First development: September 2003 Last update: December 2003
Vincenzo Zocca
Copyright 2003 by Vincenzo Zocca
This file is part of the InfoSys::FreeDB module hierarchy for Perl by Vincenzo Zocca.
InfoSys::FreeDB
The InfoSys::FreeDB module hierarchy is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
The InfoSys::FreeDB module hierarchy is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with the InfoSys::FreeDB module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
To install InfoSys::FreeDB, copy and paste the appropriate command in to your terminal.
cpanm
cpanm InfoSys::FreeDB
CPAN shell
perl -MCPAN -e shell install InfoSys::FreeDB
For more information on module installation, please visit the detailed CPAN module installation guide.