hprose for php

1.客户端和服务器简单DEMO

通过工厂方法 create 创建客户端

$client = HproseClient::create($uriList = null[, $async = true]);

create 方法与构造器函数的参数一样，返回结果也一样。但是第一个参数 $uriList 不能被省略。

使用 create 方法更加方便，因此，除非在创建客户端的时候，不想指定服务地址，否则，应该优先考虑使用 create 方法来创建客户端。

HproseClient::create 支持创建 Hprose 核心库上的客户端，HproseSwooleClient::create 支持创建 swoole 的客户端。例如：

创建一个同步的 HTTP 客户端

$client = HproseClient::create('http://hprose.com/example/', false);

创建 HTTP 服务器

use HproseHttpServer;

function hello($name) {
    return "Hello $name!";
}

$server = new Server();
$server->addFunction('hello');
$server->start();

创建一个同步的 TCP 客户端

$client = HproseClient::create('tcp://127.0.0.1:1314', false);

创建 TCP 服务器

use HproseSocketServer;

function hello($name) {
    return "Hello $name!";
}
$server = new Server("tcp://0.0.0.0:1314");
$server->addFunction('hello');
$server->start();

创建一个异步的 Unix Socket 客户端

$client = HproseClient::create('unix:/tmp/my.sock');

创建 UNIX Socket 服务器

use HproseSocketServer;

function hello($name) {
    return "Hello $name!";
}

$server = new Server("unix:/tmp/my.sock");
$server->addFunction('hello');
$server->start();

创建一个异步的 WebSocket 客户端

$client = HproseSwooleClient::create('ws://127.0.0.1:8080/');

创建 Web Socket 服务器

use HproseSwooleServer;

function hello($name) {
    return "Hello $name!";
}
$server = new Server("ws://0.0.0.0:8088");
$server->addFunction('hello');
$server->start();

2.事件

onBeforeInvoke 事件

该事件在调用执行前触发，该事件的处理函数形式为：

function($name, &$args, $byref, stdClass $context) { ... }

参数 $name 是服务函数/方法名。 参数 $args 是调用的参数数组，可以声明为引用参数。 参数 $byref 表示是否是引用参数传递。 参数 $context 是该调用的上下文参数。

如果在该事件中抛出异常、返回错误对象、或者返回一个失败（rejected）状态的 promise 对象。则不再执行服务函数/方法。

onAfterInvoke 事件

该事件在调用执行后触发，该事件的处理函数形式为：

function($name, &$args, $byref, &$result, stdClass $context) { ... }

参数 $name 是服务函数/方法名。 参数 $args 是调用的参数数组，可以声明为引用参数。 参数 $byref 表示是否是引用参数传递。 参数 $result 是调用执行的结果，可以声明为引用参数。 参数 $context 是该调用的上下文参数。

如果在该事件中抛出异常、返回错误对象、或者返回一个失败（rejected）状态的 promise 对象。则不再返回结果 $result，而是将错误信息返回给客户端。

onSendError 事件

该事件在服务端发生错误时触发，该事件的处理函数形式为：

function(&$error, stdClass $context) { ... }

如果在该事件中抛出异常、返回错误对象。则该错误会替代原来的错误信息返回给客户端。

$error 参数可以声明为引用参数，在事件中可以对 $error 进行修改。

当服务器与客户端之间发生网络中断性的错误时，仍然会触发该事件，但是不会有错误信息发送给客户端。

onSendHeader 事件

该事件在服务器发送 HTTP 头时触发，该事件的处理函数形式为：

function(stdClass $context) { ... }

如果在该事件中抛出异常，则不再执行后序操作，直接返回异常信息给客户端。

onAccept 事件

该事件在 Socket 或 WebSocket 服务器接受客户端连接时触发，该事件的处理函数形式为：

function(stdClass $context) { ... }

如果在该事件中抛出异常，则会断开跟该客户端的连接。

onClose 事件

该事件在 Socket 或 WebSocket 服务器跟客户端之间的连接关闭时触发，该事件的处理函数形式为：

function(stdClass $context) { ... }

该事件中抛出异常不会对服务器和客户端有任何影响。

onError 事件

该事件仅被 HproseSocketServer 所支持，其它服务器不支持，该事件在服务器与客户端发生通讯错误，无法将错误发送给客户端时触发。该事件的处理函数形式为：

function($error, stdClass $context) { ... }

该事件中抛出异常不会对服务器和客户端有任何影响。

官方使用手册地址：https://github.com/hprose/hprose-php/wiki