NAME

InfoSys::FreeDB::Site - FreeDB site

SYNOPSIS

 require InfoSys::FreeDB;
 
 # Create a HTTP connection
 my $fact = InfoSys::FreeDB->new();
 my $conn = $fact->create_connection( {
     client_name => 'testing-InfoSys::FreeDB',
     client_version => $InfoSys::FreeDB::VERSION,
 } );
 
 # Get sites from FreeDB
 my $res = $conn->sites();
 
 # Write the sites to STDERR
 use IO::Handle;
 my $fh = IO::Handle->new_from_fd( fileno(STDERR), 'w' );
 foreach my $site ( $res->get_site() ) {
     $fh->print( join(', ',
         $site->get_address(),
         $site->get_description(),
         $site->get_latitude(),
         $site->get_longitude(),
         $site->get_port(),
         $site->get_protocol(),
         $site->get_site(),
     ), "\n" );
 }

ABSTRACT

FreeDB site

DESCRIPTION

InfoSys::FreeDB::Site objects contain information on FreeDB sites.

CONSTRUCTOR

new( [ OPT_HASH_REF ] )

Creates a new InfoSys::FreeDB::Site object. OPT_HASH_REF is a hash reference used to pass initialization options. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

address

Passed to set_address(). Defaults to '-'.

description

Passed to set_description().

latitude

Passed to set_latitude().

longitude

Passed to set_longitude().

port

Passed to set_port().

protocol

Passed to set_protocol().

site

Passed to set_site().

METHODS

get_address()

Returns the additional addressing information needed to access the server.

get_description()

Returns the short description of the geographical location of the site.

get_latitude()

Returns the latitude of the server site.

get_longitude()

Returns the longitude of the server site.

get_port()

Returns the port at which the server resides on that site.

get_protocol()

Returns the supported protocol.

get_site()

Returns the Internet address of the remote site.

set_address(VALUE)

Set the additional addressing information needed to access the server. VALUE is the value. Default value at initialization is -. On error an exception Error::Simple is thrown.

set_description(VALUE)

Set the short description of the geographical location of the site. VALUE is the value. On error an exception Error::Simple is thrown.

set_latitude(VALUE)

Set the latitude of the server site. VALUE is the value. On error an exception Error::Simple is thrown.

set_longitude(VALUE)

Set the longitude of the server site. VALUE is the value. On error an exception Error::Simple is thrown.

set_port(VALUE)

Set the port at which the server resides on that site. VALUE is the value. On error an exception Error::Simple is thrown.

set_protocol(VALUE)

Set the supported protocol. VALUE is the value. On error an exception Error::Simple is thrown.

set_site(VALUE)

Set the Internet address of the remote site. 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, 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

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