README

See Avro for a full documentation on Avro and its usage in PHP.

This library use avro-rpc-php as an implementation of the Avro RPC protocol in php.

Installation

composer require eliep/avro-rpc-php-generator

Protocol class Generation

The script is located in your vendor/bin folder:

php vendor/bin/generate.php --help

Required arguments:

--input (-i) dir : The folder containing your Avro protocol
--output (-o) dir : The folder where the protocol classes will be written

Optional argument:

--prefix (-p) namespace: The namespace prefix of the output directory
--stringType (-s) : If the requestor will be used with a java implementation using String instead of CharSequence
--apcu (-a) : use APCu to cache the parsed protocol.

Namespacing

The generate script will respect the namespace defined in your avro protocol. For example, if you have define "my.avro" as your protocol namespace, the script:

create the folder My\Avro in the directory specified by the -o option.
use My\Avro for the generated php class.

Note: If the directory specified by the -o option has a namespace, you can use the option -p to specify it so that the namespace of the generated php class will use it.

The name of the generate class will be protocol name with the Requestor suffix (if your protocol's name is Protocol, the class name will be ProtocolRequestor);

Protocol class Usage

For example, if your protocol is:

{
 "namespace": "my.avro",
 "protocol": "Protocol",

 "types": [
     {"type": "record", "name": "SimpleRequest",
      "fields": [{"name": "subject",   "type": "string"}]
     },
     {"type": "record", "name": "SimpleResponse",
      "fields": [{"name": "something",   "type": "string"}]
     }
 ],

 "messages": {
    "requestSomething": {
      "request": [{"name": "message", "type": "SimpleRequest"}],
      "response": "SimpleResponse"
    }
  }
}

you can connect to an Avro RPC Server with

use My\Avro\ProtocolRequestor

$serverHost = '127.0.0.1';
$serverPort = 1412;
try {
  $requestor = new ProtocolRequestor($serverHost, $serverPort);
} catch (\Exception $e) {
    // unable to reach the server.
}

The ProtocolRequestor set a temporary error handler to detect if the socket connection worked. If not, the constructor throw a php Exception.

The ProtocolRequestor class contains one function for each message in your protocol. These functions accept as many argument as defined by the corresponding message.

You can call:

$response = $requestor->requestSomething(array("subject" => "ping"));

Example

An example is available in example/ folder.

Start a server

php bin/generate.php sample_rpc_server.php

Use the sample client

php bin/generate.php sample_rpc_client.php

Regenerate the sample client

php bin/generate.php --input example/avro/ --output example/ --prefix Example --stringType

eliep / avro-rpc-php-generator

Maintainers

Details