Man page or keyword search:   man All Sections 1 - General Commands 2 - System Calls 3 - Subroutines, Functions 4 - Special Files 5 - File Formats 6 - Games and Screensavers 7 - Macros and Conventions 8 - Maintenence Commands 9 - Kernel Interface New Commands Server 4.4BSD AIX Alpinelinux Archlinux Aros BSDOS BSDi Bifrost CentOS Cygwin Darwin Debian DigitalUNIX DragonFly ElementaryOS Fedora FreeBSD Gentoo GhostBSD HP-UX Haiku Hurd IRIX Inferno JazzOS Kali Knoppix LinuxMint MacOSX Mageia Mandriva Manjaro Minix MirBSD NeXTSTEP NetBSD OPENSTEP OSF1 OpenBSD OpenDarwin OpenIndiana OpenMandriva OpenServer OpenSuSE OpenVMS Oracle PC-BSD Peanut Pidora Plan9 QNX Raspbian RedHat Scientific Slackware SmartOS Solaris SuSE SunOS Syllable Tru64 UNIXv7 Ubuntu Ultrix UnixWare Xenix YellowDog aLinux   31170 pages apropos Keyword Search (all sections) Output format html ascii pdf view pdf save postscript

JSON::RPC::Common::ProUserrContributed)JSON::RPC::Common::Procedure::Return(3)

NAME
       JSON::RPC::Common::Procedure::Return - JSON-RPC procedure return class

SYNOPSIS
	       use JSON::RPC::Common::Procedure::Return;

	       # create a return from a call, retaining the ID
	       my $return = $call->return_result("foo");

	       # inflate gets a version specific class
	       my $return = JSON::RPC::Common::Procedure::Return->inflate(
		       version => "2.0",
		       result  => "foo",
		       id      => $id,
	       );

	       # you can specify a return with an error, it's just an attribute
	       my $return = JSON::RPC::Common::Procedure::Return->new(
		       error => ...,
	       );

DESCRIPTION
       This class abstracts JSON-RPC procedure returns (results).

       Version specific implementation are provided as well.

ATTRIBUTES
       id  The ID of the call this is a result for.

	   Results with no ID are typically error results for parse fails,
	   when the call ID could never be determined.

       result
	   The JSON data that is the result of the call, if any.

       error
	   The error, if any. This is a
	   JSON::RPC::Common::Procedure::Return::Error object (or a version
	   specific subclass).

       error_class
	   The error class to use when instantiating errors.

METHODS
       inflate
       deflate
	   Go to and from JSON data.

       inflate_error
       deflate_error
	   Helpers for managing the error sub object.

       set_error
	   Calls "create_error" with it's arguments and sets the error to
	   that.

	   E.g.

		   $res->set_error("foo");
		   $res->error->message; # "foo"

       create_error
	   Instantiate a new error of class error_class using "new_dwim" in
	   JSON::RPC::Common::Procedure::Return::Error.

perl v5.14.1			  2009-JSON::RPC::Common::Procedure::Return(3)

Vote for polarhome