view release on metacpan or  search on metacpan

FreeDB2.pm  view on Meta::CPAN

=item Net::FreeDB2::Connection::HTTP

Concrete connection for the HTTP protocol

=item Net::FreeDB2::Connection::CDDBP

Concrete connection for the CDDBP protocol

=item Net::FreeDB2::Entry

A FreeDB/CDDB entry. Can be read/written from/to a FreeDB/CDDB connection or a file.

=item Net::FreeDB2::Match

Match obtained from a FreeDB/CDDB query comand

=item Net::FreeDB2::Site

Site obtained from a FreeDB/CDDB sites command

=item Net::FreeDB2::Response*

Responses from FreeDB/CDDB commands

=back

=head1 CONSTRUCTOR

none

=head1 METHODS

=over

=item connection (OPT_HASH_REF || OPT_STRING)

Returns an instanciated C<Net::FreeDB2::Connection> object. C<Error::Simple> exceptions generated by instanciated classes are passed through.

Allowed/mandatory options for C<OPT_HASH_REF> are:

=over

=item protocol

Protocol to use. Allowed vaulues: C<HTTP> and C<CDDBP>. Defaults to C<HTTP>. C<HTTP> causes a C<Net::FreeDB2::Connection::HTTP> object to be instanciated. C<CDDBP> causes a C<Net::FreeDB2::Connection::CDDBP> object to be instanciated.

=item client_name

Mandatory option to name the connecting client software.

=item client_version

Mandatory option with the client software version string.

=item client_host

The hostname of the client. Defaults to C<&Sys::Hostname::hostname ()>.

=item client_user

The user of the client. Defaults to C<scalar (getpwuid ($E<gt>))>;

=item freedb_host

The FreeDB/CDDB host to use (e.g. C<www.freedb.org>). If defined together with C<freedb_cgi> the connection is actually made during costruction.

=item freedb_port

The port on the FreeDB/CDDB host to use.

=item freedb_cgi

The FreeDB/CDDB host to use (e.g. C<~cddb/cddb.cgi>). If defined together with C<freedb_host> the connection is actually made during costruction. Only for C<HTTP> protocol. Will not cause error if set for protocol <CDDBP>.

=item proxy_host

Proxy host to use. Only supported for C<HTTP> protocol. Will not cause error if set for protocol <CDDBP>.

=item proxy_port

Proxy port to use. Defaults to C<8080>. Only supported for C<HTTP> protocol. Will not cause error if set for protocol <CDDBP>.

=item proxy_user

Proxy user name to use. Only supported for C<HTTP> protocol. Will not cause error if set for protocol <CDDBP>.

=item proxy_passwd

Proxy password to use. Only supported for C<HTTP> protocol. Will not cause error if set for protocol <CDDBP>.

=back

Options are allowed to be passed as strings. In this case, C<OPT_STRING> must be in the format:
 <attribute1>=<value1>;<attribute2>=<value2>;...
Example:
 client_name=my-client;client_version=0.0.1

=back

=head1 SEE ALSO

L<Net::FreeDB2::Entry>, L<Net::FreeDB2::Match>, L<Net::FreeDB2::Response>, L<Net::FreeDB2::Response::Query> and L<Net::FreeDB2::Response::Read>

=head1 BUGS

None known (yet).

=head1 HISTORY

First development: September 2002

=head1 AUTHOR

Vincenzo Zocca E<lt>Vincenzo@Zocca.comE<gt>

=head1 COPYRIGHT

Copyright 2002, Vincenzo Zocca.

=head1 LICENSE