InfoSys::FreeDB::Response::Stat - FreeDB stat response
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" );
FreeDB stat response
InfoSys::FreeDB::Response::Stat contains information about FreeDB stat responses.
InfoSys::FreeDB::Response::Stat
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.
OPT_HASH_REF
Error::Simple
Options for OPT_HASH_REF may include:
database_entries
Passed to set_database_entries().
gets
Passed to set_gets().
posting
Passed to set_posting().
proto_cur
Passed to set_proto_cur().
proto_max
Passed to set_proto_max().
quotes
Passed to set_quotes().
strip_ext
Passed to set_strip_ext().
updates
Passed to set_updates().
users_cur
Passed to set_users_cur().
users_max
Passed to set_users_max().
Options for OPT_HASH_REF inherited through package InfoSys::FreeDB::Response may include:
InfoSys::FreeDB::Response
code
Passed to set_code(). Mandatory option.
error
Passed to set_error().
result
Passed to set_result(). Mandatory option.
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.
CONTENT_REF
This method is inherited from package InfoSys::FreeDB::Response. Returns the response code.
Returns the total number of entries in the database.
Returns the server's current operating protocol level.
Returns the maximum supported protocol level.
This method is inherited from package InfoSys::FreeDB::Response. Returns the response result text.
Returns the number of users currently connected to the server.
Returns the number of users that can concurrently connect to the server.
This method is inherited from package InfoSys::FreeDB::Response. Returns whether the response has an error or not.
Returns whether the client is allowed to get log information or not.
Returns whether the client is allowed to post new entries or not.
Returns whether the quoted arguments are enabled or not.
Returns whether the extended data is stripped by the server before presented to the user or not.
Returns whether the client is allowed to initiate a database update or not.
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.
VALUE
Set the total number of entries in the database. VALUE is the value. On error an exception Error::Simple is thrown.
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.
State that the client is allowed to get log information. VALUE is the value. On error an exception Error::Simple is thrown.
State that the client is allowed to post new entries. VALUE is the value. On error an exception Error::Simple is thrown.
Set the server's current operating protocol level. VALUE is the value. On error an exception Error::Simple is thrown.
Set the maximum supported protocol level. VALUE is the value. On error an exception Error::Simple is thrown.
State that the quoted arguments are enabled. VALUE is the value. On error an exception Error::Simple is thrown.
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.
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.
State that the client is allowed to initiate a database update. VALUE is the value. On error an exception Error::Simple is thrown.
Set the number of users currently connected to the server. VALUE is the value. On error an exception Error::Simple is thrown.
Set the number of users that can concurrently connect to the server. VALUE is the value. On error an exception Error::Simple is thrown.
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::Ver, InfoSys::FreeDB::Response::Whom, InfoSys::FreeDB::Response::Write::1, InfoSys::FreeDB::Response::Write::2, InfoSys::FreeDB::Site
None known (yet.)
First development: September 2003 Last update: December 2003
Vincenzo Zocca
Copyright 2003 by Vincenzo Zocca
This file is part of the InfoSys::FreeDB module hierarchy for Perl by Vincenzo Zocca.
InfoSys::FreeDB
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
To install InfoSys::FreeDB, copy and paste the appropriate command in to your terminal.
cpanm
cpanm InfoSys::FreeDB
CPAN shell
perl -MCPAN -e shell install InfoSys::FreeDB
For more information on module installation, please visit the detailed CPAN module installation guide.