NAME

InfoSys::FreeDB::Response::Proto - FreeDB proto response

SYNOPSIS

 require InfoSys::FreeDB;
 
 # Create a CDDBP connection
 my $fact = InfoSys::FreeDB->new();
 my $conn = $fact->create_connection( {
     client_name => 'testing-InfoSys::FreeDB',
     client_version => $InfoSys::FreeDB::VERSION,
     protocol => 'CDDBP',
 } );
 
 # What's the current protocol level on FreeDB server?
 my $res = $conn->proto();
 
 # Write the current protocol level to STDERR
 use IO::Handle;
 my $fh = IO::Handle->new_from_fd( fileno(STDERR), 'w' );
 $fh->print( "\n", $res->get_cur_level(), "\n" );
 
 # Set the protocol level to 3 on FreeDB server?
 $res = $conn->proto(3);

ABSTRACT

FreeDB proto response

DESCRIPTION

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

CONSTRUCTOR

new(OPT_HASH_REF)

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

cur_level

Passed to set_cur_level(). Defaults to 0.

supported_level

Passed to set_supported_level(). Defaults to 0.

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.

new_from_content_ref(CONTENT_REF)

Creates a new InfoSys::FreeDB::Response::Proto object from the specified content reference. CONTENT_REF is a string reference. On error an exception Error::Simple is thrown.

METHODS

get_code()

This method is inherited from package InfoSys::FreeDB::Response. Returns the response code.

get_cur_level()

Returns the current protocol level.

get_result()

This method is inherited from package InfoSys::FreeDB::Response. Returns the response result text.

get_supported_level()

Returns the supported protocol level.

is_error()

This method is inherited from package InfoSys::FreeDB::Response. Returns whether the response has an error or not.

set_code(VALUE)

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.

set_cur_level(VALUE)

Set the current protocol level. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

set_error(VALUE)

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_result(VALUE)

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_supported_level(VALUE)

Set the supported protocol level. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

SEE ALSO

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::Query manpage, the InfoSys::FreeDB::Response::Quit manpage, the InfoSys::FreeDB::Response::Read manpage, the InfoSys::FreeDB::Response::SignOn 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

BUGS

None known (yet.)

HISTORY

First development: September 2003 Last update: December 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