ufee / ratchet

PHP WebSocket库

0.5.4 2023-10-31 12:38 UTC

This package is auto-updated.

Last update: 2024-08-30 01:38:36 UTC


README

GitHub Actions Autobahn Testsuite Latest Stable Version

Ratchet是一个用于异步提供WebSocket服务的PHP库。通过简单的接口构建您的应用程序,并通过组合不同的组件重用您的应用程序,而无需更改其任何代码。

要求

需要shell访问权限,建议具有root权限。为了避免代理/防火墙阻塞,建议在端口80或443(SSL)上请求WebSocket,这需要root权限。为了实现这一点,除了您的同步Web栈之外,您可以使用反向代理或两台独立的机器。更多详细信息,请参阅服务器配置文档

文档

用户和API文档可在Ratchet网站上找到:http://socketo.me

有关使用Ratchet的一些现成演示,请参阅https://github.com/cboden/Ratchet-examples

需要帮助?有疑问?想提供反馈?请在Google Groups邮件列表上发消息。

快速示例

<?php
use Ratchet\MessageComponentInterface;
use Ratchet\ConnectionInterface;

    // Make sure composer dependencies have been installed
    require __DIR__ . '/vendor/autoload.php';

/**
 * chat.php
 * Send any incoming messages to all connected clients (except sender)
 */
class MyChat implements MessageComponentInterface {
    protected $clients;

    public function __construct() {
        $this->clients = new \SplObjectStorage;
    }

    public function onOpen(ConnectionInterface $conn) {
        $this->clients->attach($conn);
    }

    public function onMessage(ConnectionInterface $from, $msg) {
        foreach ($this->clients as $client) {
            if ($from != $client) {
                $client->send($msg);
            }
        }
    }

    public function onClose(ConnectionInterface $conn) {
        $this->clients->detach($conn);
    }

    public function onError(ConnectionInterface $conn, \Exception $e) {
        $conn->close();
    }
}

    // Run the server application through the WebSocket protocol on port 8080
    $app = new Ratchet\App('localhost', 8080);
    $app->route('/chat', new MyChat, array('*'));
    $app->route('/echo', new Ratchet\Server\EchoServer, array('*'));
    $app->run();
$ php chat.php
    // Then some JavaScript in the browser:
    var conn = new WebSocket('ws://:8080/echo');
    conn.onmessage = function(e) { console.log(e.data); };
    conn.onopen = function(e) { conn.send('Hello Me!'); };