Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

net::upnp::service(3pm) [debian man page]

Net::UPnP::Service(3pm) 				User Contributed Perl Documentation				   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() . "
";
	       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 "	$1
";
	       }
	       $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 http://www.cybergarage.org

COPYRIGHT AND LICENSE

       Copyright (C) 2005 by Satoshi Konno

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

perl v5.10.1							    2009-07-27						   Net::UPnP::Service(3pm)

Check Out this Related Man Page

GUPNP_CONTROL_POINT_CALLBACK_SET(3)					 1				       GUPNP_CONTROL_POINT_CALLBACK_SET(3)

gupnp_control_point_callback_set - Set control point callback

SYNOPSIS

       bool gupnp_control_point_callback_set (resource	$cpoint, int  $signal, mixed  $callback, [mixed  $arg])

DESCRIPTION

	Set control point callback function for signal.

PARAMETERS

	      o $cpoint
		- A control point identifier, returned by gupnp_control_point_new(3).

	      o $signal
		- The value of signal. Signal can be one of the following values:

		     o GUPNP_SIGNAL_DEVICE_PROXY_AVAILABLE - Emitted whenever a new device has become available.

		     o GUPNP_SIGNAL_DEVICE_PROXY_UNAVAILABLE - Emitted whenever a device is not available any more.

		     o GUPNP_SIGNAL_SERVICE_PROXY_AVAILABLE - Emitted whenever a new service has become available.

		     o GUPNP_SIGNAL_SERVICE_PROXY_UNAVAILABLE - Emitted whenever a service is not available any more.

	      o $callback
		- The callback function for the certain signal. Typically, callback function takes on two parameters. The $proxy parameter's iden-
		tifier being the first, and the $arg second.

	      o $arg
		- User data for $callback.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

EXAMPLES

       Example #1

	      Create new UPnP context and start browsing

	      <?php

	      function device_proxy_available_cb($proxy, $arg)
	      {
		  $info = gupnp_device_info_get($proxy);

		  $type = $info['device_type'];
		  $location = $info['location'];

		  printf("Device available:
");
		  printf("type:     %s
", $type);
		  printf("location: %s
", $location);
	      }

	      /* Create the UPnP context */
	      $context = gupnp_context_new();

	      if (!$context) {
	       die("Error creating the GUPnP context
");
	      }

	      /* We're interested in everything */
	      $cp = gupnp_control_point_new($context, "ssdp:all");

	      gupnp_control_point_callback_set($cp,
		  GUPNP_SIGNAL_DEVICE_PROXY_AVAILABLE, 'device_proxy_available_cb');

	      /* Start for browsing */
	      gupnp_control_point_browse_start($cp);

	      ?>

ERRORS
/EXCEPTIONS
	Issues E_WARNING with not valid callback function.

SEE ALSO

       gupnp_control_point_new(3), gupnp_control_point_browse_start(3).

PHP Documentation Group 										       GUPNP_CONTROL_POINT_CALLBACK_SET(3)
Man Page