Wrench 项目技术文档

1. 安装指南

使用 Composer 安装

Wrench 是一个基于 PHP 7.1 的简单 WebSocket 客户端/服务器库。你可以通过 Composer 来安装它。以下是安装步骤：

1. 确保你已经安装了 Composer。如果还没有安装，请先安装 Composer。
2. 在你的项目根目录下运行以下命令来安装 Wrench：

composer require wrench/wrench ~3.0

安装 PHP 5 版本（可选）

如果你需要支持 PHP 5，可以使用 Wrench 的 2.0 分支版本。安装命令如下：

composer require wrench/wrench ~2.0

2. 项目的使用说明

创建 WebSocket 服务器

以下是一个简单的 WebSocket 服务器示例，它监听 ws://localhost:8000 地址，并注册了两个应用程序：echo 和 chat。

/**
 * 一个简单的应用程序，将接收到的数据回显给发送者
 */
$app = new class implements \Wrench\Application\DataHandlerInterface
{
    public function onData(string $data, \Wrench\Connection $connection): void
    {
        $connection->send($data);
    }
};

// 创建一个 WebSocket 服务器，监听端口 8000
$server = new \Wrench\BasicServer('ws://localhost:8000', array(
    'allowed_origins' => array(
        'mysite.com',
        'mysite.dev.localdomain'
    )
));

$server->registerApplication('echo', $app);
$server->registerApplication('chat', new \My\ChatApplication());
$server->setLogger($monolog); // PSR3
$server->run();

创建 WebSocket 客户端

以下是一个简单的 WebSocket 客户端示例，它连接到服务器并发送一条消息，然后接收服务器的响应。

/**
 * 一个客户端示例，发送一条消息并接收服务器的响应
 */
$client = new Client('ws://localhost:8000, http://localhost:8000);
$client->connect();
$client->sendData('hello');
$response = $client->receive()[0]->getPayload();
$client->disconnect();

3. 项目 API 使用文档

服务器端 API

Wrench\BasicServer

• __construct(string $uri, array $options = []): 创建一个 WebSocket 服务器实例。

  • $uri: 服务器监听的 URI，例如 ws://localhost:8000。
  • $options: 可选的服务器配置选项，例如 allowed_origins。

• registerApplication(string $path, \Wrench\Application\ApplicationInterface $application): 注册一个应用程序。

  • $path: 应用程序的路径，例如 echo。
  • $application: 应用程序实例。

• setLogger(\Psr\Log\LoggerInterface $logger): 设置日志记录器。

• run(): 启动服务器。

客户端 API

Wrench\Client

• __construct(string $uri, string $origin): 创建一个 WebSocket 客户端实例。

  • $uri: 服务器 URI，例如 ws://localhost:8000。
  • $origin: 客户端的 Origin。

• connect(): 连接到服务器。

• sendData(string $data): 发送数据到服务器。

• receive(): 接收服务器的响应。

• disconnect(): 断开与服务器的连接。

4. 项目安装方式

Wrench 项目可以通过 Composer 进行安装。以下是安装步骤：

1. 打开终端或命令行工具。
2. 进入你的项目目录。
3. 运行以下命令来安装 Wrench：

composer require wrench/wrench ~3.0

如果你需要支持 PHP 5，可以使用以下命令安装 2.0 版本：

composer require wrench/wrench ~2.0

安装完成后，你可以在项目中使用 Wrench 来创建 WebSocket 服务器和客户端。