GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  JSON::RPC::COMMON::PROCEDURE::CALL (3)

.ds Aq ’

NAME

JSON::RPC::Common::Procedure::Call - JSON RPC Procedure Call base class.

CONTENTS

VERSION

version 0.11

SYNOPSIS



        use JSON::RPC::Common::Procedure::Call;

        my $req = JSON::RPC::Common::Procedure::Call->inflate({ ... });

        warn "HALLO JSONRPC VERSION " . $req->version;



DESCRIPTION

A JSON-RPC Procedure Call (ed: *rolls eys*, what was wrong with request?) is either a notification or a method invocation in JSON-PRC.

See <http://json-rpc.org/wiki/specification> for more details.

ATTRIBUTES

All attributes are read only unless otherwise specified.
version
id The request ID.

Used to correlate a request to a response.

method The name of the method to invoke.
params Returns a reference to the parameters hash or array.
return_class
error_class The classes to instantiate the response objects.

These vary per subclass.

METHODS

inflate A factory constructor. Delegates to new on a subclass based on the protocol version.

This is the recommended constructor.

deflate Flatten to JSON data
new The actual constructor.

Not intended for normal use on this class, you should use a subclass most of the time.

Calling JSON::RPC::Common::Procedure::Call->new will construct a call with an undefined version, which cannot be deflated (and thus sent over the wire). This is still useful for testing your own code’s RPC hanlding, so this is not allowed.

params_list Dereferences params regardless of representation.

Returns a list of positionals or a key/value list.

return_result $result
return_error %error_params Create a new JSON::RPC::Common::Procedure::Return with or without an error.
is_notification Whether this request is a notification (a method that does not need a response).
is_service Whether this request is a JSON-RPC 1.1 service method (e.g. system.describe).

This method is always false for 1.0 and 2.0.

call $obj A convenience method to invoke the call on $obj and create a new return with the return value.

AUTHOR

Yuval Kogman <nothingmuch@woobling.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Yuval Kogman and others.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 JSON::RPC::COMMON::PROCEDURE::CALL (3) 2014-02-28

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.