InfoSys::FreeDB::Response::Stat - FreeDB stat response

NAME
SYNOPSIS
ABSTRACT
DESCRIPTION
CONSTRUCTOR
METHODS
SEE ALSO
BUGS
HISTORY
AUTHOR
COPYRIGHT
LICENSE

NAME

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 stat from FreeDB
 my $res = $conn->stat();
 
 # Write a bit of stat to STDERR
 use IO::Handle;
 my $fh = IO::Handle->new_from_fd( fileno(STDERR), 'w' );
 $fh->print( "\n", $res->get_proto_cur(), "\n" );

ABSTRACT

FreeDB stat response

DESCRIPTION

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

CONSTRUCTOR

new(OPT_HASH_REF): Creates a new InfoSys::FreeDB::Response::Stat 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:
new_from_content_ref(CONTENT_REF): Creates a new InfoSys::FreeDB::Response::Stat 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_database_entries(): Returns the total number of entries in the database.
get_proto_cur(): Returns the server's current operating protocol level.
get_proto_max(): Returns the maximum supported protocol level.
get_result(): This method is inherited from package InfoSys::FreeDB::Response. Returns the response result text.
get_users_cur(): Returns the number of users currently connected to the server.
get_users_max(): Returns the number of users that can concurrently connect to the server.
is_error(): This method is inherited from package InfoSys::FreeDB::Response. Returns whether the response has an error or not.
is_gets(): Returns whether the client is allowed to get log information or not.
is_posting(): Returns whether the client is allowed to post new entries or not.
is_quotes(): Returns whether the quoted arguments are enabled or not.
is_strip_ext(): Returns whether the extended data is stripped by the server before presented to the user or not.
is_updates(): Returns whether the client is allowed to initiate a database update 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_database_entries(VALUE): Set the total number of entries in the database. VALUE is the value. 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_gets(VALUE): State that the client is allowed to get log information. VALUE is the value. On error an exception Error::Simple is thrown.
set_posting(VALUE): State that the client is allowed to post new entries. VALUE is the value. On error an exception Error::Simple is thrown.
set_proto_cur(VALUE): Set the server's current operating protocol level. VALUE is the value. On error an exception Error::Simple is thrown.
set_proto_max(VALUE): Set the maximum supported protocol level. VALUE is the value. On error an exception Error::Simple is thrown.
set_quotes(VALUE): State that the quoted arguments are enabled. 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_strip_ext(VALUE): State that the extended data is stripped by the server before presented to the user. VALUE is the value. On error an exception Error::Simple is thrown.
set_updates(VALUE): State that the client is allowed to initiate a database update. VALUE is the value. On error an exception Error::Simple is thrown.
set_users_cur(VALUE): Set the number of users currently connected to the server. VALUE is the value. On error an exception Error::Simple is thrown.
set_users_max(VALUE): Set the number of users that can concurrently connect to the server. VALUE is the value. On error an exception Error::Simple is thrown.

BUGS

None known (yet.)

HISTORY

First development: September 2003 Last update: December 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

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