Codex

Net::DBus::Error

Section: User Contributed Perl Documentation (3pm)

Updated: 2011-06-30

Index?action=index Return to Main Contents


NAME

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

SYNOPSIS

DESCRIPTION

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

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 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 parameter, and long descriptive text is provided by the parameter. The 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


Index

NAME

SYNOPSIS

DESCRIPTION

METHODS

AUTHOR

COPYRIGHT

SEE ALSO