# -*- perl -*-
#
# Copyright (C) 2004-2011 Daniel P. Berrange
#
# This program is free software; You can redistribute it and/or modify
# it under the same terms as Perl itself. Either:
#
# a) the GNU General Public License as published by the Free
# Software Foundation; either version 2, or (at your option) any
# later version,
#
# or
#
# b) the "Artistic License"
#
# The file "COPYING" distributed along with this file provides full
# details of the terms and conditions of the two licenses.
=pod
=head1 NAME
Net::DBus::Binding::Message::MethodReturn - a message encoding a method return
=head1 DESCRIPTION
This module is part of the low-level DBus binding APIs, and
should not be used by application code. No guarentees are made
about APIs under the C<Net::DBus::Binding::> namespace being
stable across releases.
This module provides a convenience constructor for creating
a message representing an method return.
=head1 METHODS
=over 4
=cut
package Net::DBus::Binding::Message::MethodReturn;
use 5.006;
use strict;
use warnings;
use Net::DBus;
use base qw(Exporter Net::DBus::Binding::Message);
=item my $return = Net::DBus::Binding::Message::MethodReturn->new(
call => $method_call);
Create a message representing a reply to the method call passed in
the C<call> parameter.
=cut
sub new {
my $proto = shift;
my $class = ref($proto) || $proto;
my %params = @_;
my $call = exists $params{call} ? $params{call} : die "call parameter is required";
my $msg = exists $params{message} ? $params{message} :
Net::DBus::Binding::Message::MethodReturn::_create($call->{message});
my $self = $class->SUPER::new(message => $msg);
bless $self, $class;
return $self;
}
1;
__END__
=back
=head1 AUTHOR
Daniel P. Berrange.
=head1 COPYRIGHT
Copyright (C) 2005-2009 Daniel P. Berrange
=head1 SEE ALSO
L<Net::DBus::Binding::Message>
=cut