JSON::RPC::Server::CGI - JSON-RPC sever for CGI

NAME

JSON::RPC::Server::CGI - JSON-RPC sever for CGI

SYNOPSIS

 # CGI version
 #--------------------------
 # In your CGI script
 use JSON::RPC::Server::CGI;
 
 my $server = JSON::RPC::Server::CGI->new;

 $server->dispatch('MyApp')->handle();
 
 # or  an array ref setting
 
 $server->dispatch( [qw/MyApp MyApp::Subclass/] )->handle();
 
 # or a hash ref setting
 
 $server->dispatch( {'/jsonrpc/API' => 'MyApp'} )->handle();
 
 
 #--------------------------
 # In your application class
 package MyApp;
 
 use base qw(JSON::RPC::Procedure); # Perl 5.6 or more than
 
 sub echo : Public {    # new version style. called by clients
     # first argument is JSON::RPC::Server object.
     return $_[1];
 }
 
 sub sum : Public(a:num, b:num) { # sets value into object member a, b.
     my ($s, $obj) = @_;
     # return a scalar value or a hashref or an arryaref.
     return $obj->{a} + $obj->{b};
 }
 
 sub a_private_method : Private {
     # ... can't be called by client
 }
 
 sub sum_old_style {  # old version style. taken as Public
     my ($s, @arg) = @_;
    return $arg[0] + $arg[1];
 }

DESCRIPTION

Gets a client request.

Parses its JSON data.

Passes the server object and the object decoded from the JSON data to your procedure (method).

Takes your returned value (scalar or arrayref or hashref).

Sends a response.

Well, you write your procedure code only.

METHODS

They are inherited from the the JSON::RPC::Server manpage methods basically. The below methods are implemented in JSON::RPC::Server::CGI.

new: Creates new JSON::RPC::Server::CGI object.
retrieve_json_from_post: retrieves a JSON request from the body in POST method.
retrieve_json_from_get: In the protocol v1.1, 'GET' request method is also allowable. it retrieves a JSON request from the query string in GET method.
response: returns a response JSON data to a client.
cgi: returns the the CGI manpage object.

AUTHOR

Makamaka Hannyaharamitu, <makamaka[at]cpan.org>

COPYRIGHT AND LICENSE

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