/ 
InfoSys-FreeDB-0.9
River stage zero No dependents
/ InfoSys::FreeDB::Response

NAME

InfoSys::FreeDB::Response - FreeDB response

SYNOPSIS

None. This is an abstract class.

ABSTRACT

FreeDB response

DESCRIPTION

InfoSys::FreeDB::Response contains information about FreeDB responses.

EXPORT

By default nothing is exported.

line_parse

This tag contains variables useful to parse the messages from FreeDB servers.

$CODE_RX

Regular expression to parse the return code and the remaining tail.

CONSTRUCTOR

new(OPT_HASH_REF)

Creates a new InfoSys::FreeDB::Response 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:

code

Passed to set_code(). Mandatory option.

error

Passed to set_error().

result

Passed to set_result(). Mandatory option.

METHODS

get_code()

Returns the response code.

get_result()

Returns the response result text.

is_error()

Returns whether the response has an error or not.

set_code(VALUE)

Set the response code. VALUE is the value. On error an exception Error::Simple is thrown.

set_error(VALUE)

State that the response has an error. VALUE is the value. On error an exception Error::Simple is thrown.

set_result(VALUE)

Set the response result text. VALUE is the value. On error an exception Error::Simple is thrown.

SEE ALSO

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::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::SignOn, 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

BUGS

None known (yet.)

HISTORY

First development: September 2003 Last update: October 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2003 by Vincenzo Zocca

LICENSE

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