Yar - Yet Another RPC framework for PHP

Light, concurrent RPC framework for PHP(c, java etc will be supported soon)

Requirement

• PHP >= 5.2
• Curl
• Json
• Msgpack (Optional)

Introduce

Yar is a RPC framwork which aim to provide a simply and easy way for communicating between PHP applications

It also provide ability to call remote services concurrently.

Features

• Fast, Easy, Simply
• Concurrent RPC calls
• Multi package protocols supported (php, json, msgpack built-in)
• Multi transfe protocols supported (http implemented, tcp/unix will be supported later)
• Authentication
• Rich debug infomations

Server

It's very easy to setup a Yar RPC Server

<?php
    class API {
    /**
     * the doc info will be generated automaticly into service info page.
     * @params 
     * @return
     */
    public function api($parameter, $option = "foo") {
    }

    protected function client_can_not_see() {
    }
}

$service = new Yar_Server(new API());
$service->handle();
?>

then if a GET request to this api uri comes, a service info will be auto generated to client:

[]

Client

Normal call

It's very easy for a PHP client to call remote RPC:

<?php
$client = new Yar_Client("http://host/api/");
$result = $client->api("parameter);
?>

Concurrent call

<?php
function callback($retval, $sequence_id, $method_name, $uri) {
     var_dump($retval);
}

Yar_Concurrent_Client::call("http://host/api/", "api", array("parameters"), "callback");
Yar_Concurrent_Client::call("http://host/api/", "api", array("parameters"), "callback");
Yar_Concurrent_Client::call("http://host/api/", "api", array("parameters"), "callback");
Yar_Concurrent_Client::call("http://host/api/", "api", array("parameters"), "callback");
Yar_Concurrent_Client::loop(); //send
?>

Authentication

If a server want his client to be authenticated, yes, it is also very easy, all it have to to is declaring a method named "_auth"

<?php
    class API {
    
    /**
     * if this method return false, then the rpc call will be denied
     */
    public function _auth($user, $password) {
    }
    
    /**
     * the doc info will be generated automaticly into service info page.
     * @params 
     * @return
     */
    public function api($parameter, $option = "foo") {
    }

    protected function client_can_not_see() {
    }
}

$service = new Yar_Server(new API());
$service->handle();
?>

the client should be change to :

<?php
$client = new Yar_Client("http://username:password@host/api/");
$result = $client->api("parameter);
?>