Net::UPnP::Service (3)

Leading comments

Automatically generated by Pod::Man 2.1801 (Pod::Simple 3.05)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Net::UPnP::Service.3pm".)

NAME

Net::UPnP::Service - Perl extension for UPnP.

SYNOPSIS

    use Net::UPnP::ControlPoint;

    my $obj = Net::UPnP::ControlPoint->new();

    @dev_list = $obj->search(st =>'upnp:rootdevice', mx => 3);

    $devNum= 0;
    foreach $dev (@dev_list) {
        $device_type = $dev->getdevicetype();
        if  ($device_type ne 'urn:schemas-upnp-org:device:MediaServer:1') {
            next;
        }
        print "[$devNum] : " . $dev->getfriendlyname() . "\n";
        unless ($dev->getservicebyname('urn:schemas-upnp-org:service:ContentDirectory:1')) {
            next;
        }
        $condir_service = $dev->getservicebyname('urn:schemas-upnp-org:service:ContentDirectory:1');
        unless (defined(condir_service)) {
            next;
        }
        %action_in_arg = (
                'ObjectID' => 0,
                'BrowseFlag' => 'BrowseDirectChildren',
                'Filter' => '*',
                'StartingIndex' => 0,
                'RequestedCount' => 0,
                'SortCriteria' => '',
            );
        $action_res = $condir_service->postcontrol('Browse', \%action_in_arg);
        unless ($action_res->getstatuscode() == 200) {
                next;
        }
        $actrion_out_arg = $action_res->getargumentlist();
        unless ($actrion_out_arg->{'Result'}) {
            next;
        }
        $result = $actrion_out_arg->{'Result'};
        while ($result =~ m/<dc:title>(.*?)<\/dc:title>/sgi) {
            print "\t$1\n";
        }
        $devNum++;
    }

DESCRIPTION

The package is used a object of UPnP service.

METHODS

getdevice - get the device.

    $description = $service->getdevice();

Get the parent device of the service.

getdevicedescription - get the service description of the device description.

    $description = $service->getdevicedescription(
                                name => $name # undef
                             );

Get the service description of the device description.

The function returns the all description when the name parameter is not specified, otherwise return a value the specified name.

getservicetype - get the service type.

    $service_type = $service->getservicetype();

Get the service type.

getserviceid - get the service id.

    $service_id = $service->getserviceid();

Get the service id.

postaction - post a action control.

    $action_res = $service->postcontrol($action_name, \%action_arg);

Post a action control to the device, and return Net::UPnP::ActionResponse.

The method was renamed from postcontrol(), but the old name is deprecated.

postquery - post a query control.

    $query_res = $service->postcontrol($var_name);

Post a query control to the device, and return Net::UPnP::QueryResponse.

SEE ALSO

Net::UPnP::ActionResponse

AUTHOR

Satoshi Konno skonno@cybergarage.org

CyberGarage www.cybergarage.org

COPYRIGHT AND LICENSE

Copyright (C) 2005 by Satoshi Konno

It may be used, redistributed, and/or modified under the terms of

License.