Git Product home page Git Product logo

tivoka's Introduction

JSON-RPC done right

client and server for PHP 5.3+

Do JSON-RPC. With Tivoka. It's as easy as that!
For convenience, you can easily switch between JSON-RPC 1.0 and JSON-RPC 2.0 without having to change your code.

Learn more about JSON-RPC at http://jsonrpc.org/.

Examples

These are just some quick examples.

Do a request through HTTP...

<?php
$connection = Tivoka\Client::connect('http://exapmle.com/api')
$request = $connection->sendRequest('substract', array(51, 9));
print $request->result;// 42
?>

...or plain TCP

<?php
$connection = Tivoka\Client::connect(array('host' => 'example.com', 'port' => 1234))
$request = $connection->sendRequest('substract', array(51, 9));
print $request->result;// 42
?>

Create a server

<?php
$methods = array(
    'substract' => function($params) {
        list($num1, $num2) = $params
        return $num1 - $num2;
    }
);
Tivoka\Server::provide($methods)->dispatch();
?>

Links

  • Have a look at the documentation in doc/
  • Submit any bugs, suggestions or questions to the issue tracker

Installation

Install composer package

  1. Set up composer.json in your project directory:
{
  "require":{"tivoka/tivoka":"*"}
}
  1. Run composer:
$ php composer.phar install

Now, include 'vendor/autoload.php'

Install through pear

  1. Run the following:
$ pear channel-discover pearhub.org
$ pear install pearhub/tivoka

Now, include 'tivoka/include.php'

Download

  1. Grab the source using
  • git clone https://github.com/marcelklehr/tivoka.git or
  • download it

Now, include 'path/to/tivoka/include.php'

License

Copyright 2011-2012 by Marcel Klehr
MIT License.

Changelog

3.2.0

  • Feature: Plain TCP connections (revamped a lot of our internals along the way! thanks go out to @rafalwrzeszcz)
  • Feature: Configurable connection timeout

3.1.0

  • Fix #27: json-rpc response[result] may be null (thanks to vaab)
  • Feature: Allow setting of request headers and expose response headers (thanks to vaab)
  • Fix bug with client-side notifications
  • Add docs in doc/

3.0.1

  • Fix a typo, that used to screw up things when throwing an exception (thanks to gahr)

3.0.0

  • use Namespaces (no longer supports php5.2)
  • new factory classes (per server/client)
  • Requests no longer require $id argument
  • Dramatically simplified serverside usage
  • Fluid spec version setter
  • Now available as composer package

2.0.3

  • Added HTTPS support
  • target scheme is now treated case insensitive

2.0.2

  • Introduced new directory structure
  • Fixed #10
  • Some Exception messages changed slightly to be more specific

2.0.1

  • Patched http method spelling (make uppercase, so all servers accept it)

2.0.0

  • complete Code base rework
  • major API change
  • removed Response Class
  • Added aa number of shortcuts
  • Implemented native remote interface

tivoka's People

Contributors

marcelklehr avatar vaab avatar rafalwrzeszcz avatar william-gr avatar

Watchers

Lee Saferite avatar Axel Jung avatar Christian Zenker avatar Michael Klapper avatar Fabrizio Branca avatar Tymoteusz Motylewski avatar James Cloos avatar Timo Hund avatar Christoph Frenes avatar Johannes Reinig avatar Daniel Zohm avatar Chetan Thapliyal avatar Kevin Schu avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.