Peter Makholm > AnyEvent-JSONRPC-0.15 > AnyEvent::JSONRPC::HTTP::Server

Download:
AnyEvent-JSONRPC-0.15.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  5
Open  0
View/Report Bugs
Source  

NAME ^

AnyEvent::JSONRPC::HTTP::Server - Simple HTTP-based JSONRPC server

SYNOPSIS ^

    use AnyEvent::JSONRPC::HTTP::Server;
    
    my $server = AnyEvent::JSONRPC::HTTP::Server->new( port => 8080 );
    $server->reg_cb(
        echo => sub {
            my ($res_cv, @params) = @_;
            $res_cv->result(@params);
        },
        sum => sub {
            my ($res_cv, @params) = @_;
            $res_cv->result( $params[0] + $params[1] );
        },
    );

DESCRIPTION ^

This module is server part of AnyEvent::JSONRPC.

METHOD ^

new (%options) ^

Create server object, start listening socket, and return object.

    my $server = AnyEvent::JSONRPC::HTTP::Server->new(
        port => 4423,
    );

Available %options are:

host => 'Str'

Bind address. Default to 'localhost'.

If you want to use unix socket, this option should be set to "unix/"

port => 'Int | Str'

Listening port. Default to '8080'.

reg_cb (%callbacks)

Register JSONRPC methods.

    $server->reg_cb(
        echo => sub {
            my ($res_cv, @params) = @_;
            $res_cv->result(@params);
        },
        sum => sub {
            my ($res_cv, @params) = @_;
            $res_cv->result( $params[0] + $params[1] );
        },
    );

callback arguments

JSONRPC callback arguments consists of $result_cv, and request @params.

    my ($result_cv, @params) = @_;

$result_cv is AnyEvent::JSONRPC::CondVar object. Callback must be call $result_cv->result to return result or $result_cv->error to return error.

If $result_cv->is_notification() returns true, this is a notify request and the result will not be send to the client.

@params is same as request parameter.

SEE ALSO ^

JSON::RPC::Dispatch

A server based on PSGI/Plack. Quite more flexible than this module.

AUTHOR ^

Peter Makholm <peter@makholm.net>

COPYRIGHT AND LICENSE ^

Copyright (c) 2010 by Peter Makholm.

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

The full text of the license can be found in the LICENSE file included with this module.

syntax highlighting: