.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Net::DBus::Error 3"
.TH Net::DBus::Error 3 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Net::DBus::Error \- Error details for remote method invocation
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  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 =~ /\e.(mp3|ogg)$/) {
\&          ...play the track
\&      } else {
\&         die Music::Player::UnknownFormat\->new();
\&      }
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This objects provides for strongly typed error handling. Normally
a service would simply call
.PP
.Vb 1
\&  die "some message text"
.Ve
.PP
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 \f(CW\*(C`Net::DBus::Error\*(C'\fR
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.
.SH METHODS
.IX Header "METHODS"
.ie n .IP "my $error = Net::DBus::Error\->new(name => $error_name, message => $description);" 4
.el .IP "my \f(CW$error\fR = Net::DBus::Error\->new(name => \f(CW$error_name\fR, message => \f(CW$description\fR);" 4
.IX Item "my $error = Net::DBus::Error->new(name => $error_name, message => $description);"
Creates a new error object whose name is given by the \f(CW\*(C`name\*(C'\fR
parameter, and long descriptive text is provided by the
\&\f(CW\*(C`message\*(C'\fR parameter. The \f(CW\*(C`name\*(C'\fR 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'.
.ie n .IP $error\->name 4
.el .IP \f(CW$error\fR\->name 4
.IX Item "$error->name"
Returns the DBus error name associated with the object.
.ie n .IP $error\->message 4
.el .IP \f(CW$error\fR\->message 4
.IX Item "$error->message"
Returns the descriptive text/message associated with the
error condition.
.ie n .IP $error\->stringify 4
.el .IP \f(CW$error\fR\->stringify 4
.IX Item "$error->stringify"
Formats the error as a string in a manner suitable for
printing out / logging / displaying to the user, etc.
.SH AUTHOR
.IX Header "AUTHOR"
Daniel P. Berrange
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2005\-2011 Daniel P. Berrange
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Net::DBus, Net::DBus::Object