David Precious > Net-Shoutcast-Admin-0.02 > Net::Shoutcast::Admin::Listener

Download:
Net-Shoutcast-Admin-0.02.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
Report a bug
Module Version: 0.01   Source  

NAME ^

Net::Shoutcast::Admin::Listener - object to represent a listener

DESCRIPTION ^

An object representing a listener, returned by Net::Shoutcast::Admin.

SYNOPSIS ^

    use Net::Shoutcast::Admin;

    my $shoutcast = Net::Shoutcast::Admin->new(
                                    host => 'server hostname',
                                    port => 8000,
                                    admin_password => 'mypassword',
    );
    
    if ($shoutcast->source_connected) {
        my @listeners = $shoutcast->listeners;
        
        for my $listener (@listeners) {
            printf "Listener from %s, listening for %s",
                $listener->host, $listener->listen_time
            ;
        }
    } else {
        print "No source is currently connected.";
    }

DESCRIPTION ^

Object representing a listener, returned by Net::Shoutcast::Admin

INTERFACE ^

new

There's no reason to create instances of Net::Shoutcast::Admin::Listener directly; Net::Shoutcast::Admin creates and returns instances for you.

Having said that:

  $song = Net::Shoutcast::Admin::Listener->new( %params );

Creates a new Net::Shoutcast::Admin::Listener object. Takes a hash of options as follows:

host

The host from which this listener is connected

connect_time

The number of seconds this listener has been connected

underruns

The number of buffer underruns this listener has suffered

agent

The software this user is reportedly using to listen

host

Returns the hostname this listener is connected from

listen_time

Returns the number of seconds this listener has been connected

underruns

Returns the number of buffer underruns this listener has suffered

agent

Returns the agent this listener is reportedly using

BUGS AND LIMITATIONS ^

No bugs have been reported.

Please report any bugs or feature requests to bug-net-shoutcast-admin@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR ^

David Precious <davidp@preshweb.co.uk>

LICENCE AND COPYRIGHT ^

Copyright (c) 2008, David Precious <davidp@preshweb.co.uk>. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.