Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

net::dbus::remoteservice(3pm) [debian man page]

Net::DBus::RemoteService(3pm)				User Contributed Perl Documentation			     Net::DBus::RemoteService(3pm)

NAME

       Net::DBus::RemoteService - Access services provided on the bus

SYNOPSIS

	 my $bus = Net::DBus->find;
	 my $service = $bus->get_service("org.freedesktop.DBus");

	 my $object = $service->get_object("/org/freedesktop/DBus");
	 foreach (@{$object->ListNames}) {
	   print "$_
";
	 }

DESCRIPTION

       This object provides a handle to a remote service on the bus. From this handle it is possible to access objects associated with the
       service. If a service is not running, an attempt will be made to activate it the first time a method is called against one of its objects.

METHODS

       my $service = Net::DBus::RemoteService->new($bus, $owner, $service_name);
	   Creates a new handle for a remote service. The $bus parameter is an instance of Net::DBus, $owner is the name of the client providing
	   the service, while $service_name is the well known name of the  service on the bus. Service names consist of two or more tokens,
	   separated by periods, while the tokens comprise the letters a-z, A-Z, 0-9 and _, for example "org.freedesktop.DBus". There is generally
	   no need to call this constructor, instead the "get_service" method on Net::DBus should be used. This caches handles to remote services,
	   eliminating repeated retrieval of introspection data.

       my $bus = $service->get_bus;
	   Retrieves a handle for the bus to which this service is attached.  The returned object will be an instance of Net::DBus.

       my $service_name = $service->get_service_name
	   Retrieves the name of the remote service as known to the bus.

       my $owner_name = $service->get_owner_name;
	   Retrieves the name of the client owning the service at the time it was connected to.

       my $object = $service->get_object($object_path[, $interface]);
	   Retrieves a handle to the remote object provided by the service  with the name of $object_path. If the optional $interface parameter is
	   provided, the object will immediately be cast to the designated interface. NB, it is only neccessary to cast an object to a specific
	   interface if there are multiple interfaces on the object providing methods with the same name, or the remote object does support
	   introspection. The returned object will be an instance of Net::DBus::RemoteObject.

AUTHOR

       Daniel Berrange <dan@berrange.com>

COPYRIGHT

       Copright (C) 2004-2011, Daniel Berrange.

SEE ALSO

       Net::DBus::RemoteObject, Net::DBus::Service, Net::DBus

perl v5.14.2							    2011-06-30					     Net::DBus::RemoteService(3pm)

Check Out this Related Man Page

Net::DBus::Error(3pm)					User Contributed Perl Documentation				     Net::DBus::Error(3pm)

NAME

       Net::DBus::Error - Error details for remote method invocation

SYNOPSIS

	 package Music::Player::UnknownFormat;

	 use base qw(Net::DBus::Error);

	 # Define an error type for unknown track encoding type
	 # for a music player service
	 sub new {
	     my $proto = shift;
	     my $class = ref($proto) || $proto;
	     my $self = $class->SUPER::new(name => "org.example.music.UnknownFormat",
					   message => "Unknown track encoding format");
	 }

	 package Music::Player::Engine;

	 ...snip...

	 # Play either mp3 or ogg music tracks, otherwise
	 # thrown an error
	 sub play {
	     my $self = shift;
	     my $url = shift;

	     if ($url =~ /.(mp3|ogg)$/) {
		 ...play the track
	     } else {
		die Music::Player::UnknownFormat->new();
	     }
	 }

DESCRIPTION

       This objects provides for strongly typed error handling. Normally a service would simply call

	 die "some message text"

       When returning the error condition to the calling DBus client, the message is associated with a generic error code or
       "org.freedesktop.DBus.Failed".  While this suffices for many applications, occasionally it is desirable to be able to catch and handle
       specific error conditions. For such scenarios the service should create subclasses of the "Net::DBus::Error" object providing in a custom
       error name. This error name is then sent back to the client instead of the genreic "org.freedesktop.DBus.Failed" code.

METHODS

       my $error = Net::DBus::Error->new(name => $error_name, message => $description);
	   Creates a new error object whose name is given by the "name" parameter, and long descriptive text is provided by the "message"
	   parameter. The "name" parameter has certain formatting rules which must be adhered to. It must only contain the letters 'a'-'Z',
	   '0'-'9', '-', '_' and '.'. There must be at least two components separated by a '.', For example a valid name is
	   'org.example.Music.UnknownFormat'.

       $error->name
	   Returns the DBus error name associated with the object.

       $error->message
	   Returns the descriptive text/message associated with the error condition.

       $error->stringify
	   Formats the error as a string in a manner suitable for printing out / logging / displaying to the user, etc.

AUTHOR

       Daniel P. Berrange

COPYRIGHT

       Copyright (C) 2005-2011 Daniel P. Berrange

SEE ALSO

       Net::DBus, Net::DBus::Object

perl v5.14.2							    2011-06-30						     Net::DBus::Error(3pm)
Man Page