InfoSys::FreeDB::Response::SignOn - FreeDB sign-on response
This class is used internally by the InfoSys::FreeDB::Connection::CDDBP class.
FreeDB sign-on response
InfoSys::FreeDB::Response::SignOn contains information about FreeDB sign-on responses.
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.
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:
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.
get_code()
This method is inherited from package InfoSys::FreeDB::Response. Returns the response code.
get_date()
Returns the current date and time.
get_hostname()
Returns the server host name.
get_result()
This method is inherited from package InfoSys::FreeDB::Response. Returns the response result text.
get_version()
Returns the version number of server software.
is_connection_allowed()
Returns whether connecting is allowed or not.
is_error()
This method is inherited from package InfoSys::FreeDB::Response. Returns whether the response has an error or not.
is_read_allowed()
Returns whether reading is allowed or not.
is_write_allowed()
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.
State that connecting is allowed. VALUE is the value. Default value at initialization is 1. On error an exception Error::Simple is thrown.
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.
the InfoSys::FreeDB manpage, the InfoSys::FreeDB::Connection manpage, the InfoSys::FreeDB::Connection::CDDBP manpage, the InfoSys::FreeDB::Connection::HTTP manpage, the InfoSys::FreeDB::Entry manpage, the InfoSys::FreeDB::Entry::Track manpage, the InfoSys::FreeDB::Match manpage, the InfoSys::FreeDB::Response manpage, the InfoSys::FreeDB::Response::DiscId manpage, the InfoSys::FreeDB::Response::Hello manpage, the InfoSys::FreeDB::Response::LsCat manpage, the InfoSys::FreeDB::Response::Motd manpage, the InfoSys::FreeDB::Response::Proto manpage, the InfoSys::FreeDB::Response::Query manpage, the InfoSys::FreeDB::Response::Quit manpage, the InfoSys::FreeDB::Response::Read manpage, the InfoSys::FreeDB::Response::Sites manpage, the InfoSys::FreeDB::Response::Stat manpage, the InfoSys::FreeDB::Response::Ver manpage, the InfoSys::FreeDB::Response::Whom manpage, the InfoSys::FreeDB::Response::Write::1 manpage, the InfoSys::FreeDB::Response::Write::2 manpage, the InfoSys::FreeDB::Site manpage
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.
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