Jesse Luehrs > JSON-RPC-Common > JSON::RPC::Common::Procedure::Call

Download:
JSON-RPC-Common-0.10.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.10   Source   Latest Release: JSON-RPC-Common-0.11

NAME ^

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

VERSION ^

version 0.10

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) 2011 by Yuval Kogman.

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

syntax highlighting: