devristo/phpws

此包已被废弃,不再维护。没有建议的替代包。
对于此包的最新版本(dev-master),没有可用的许可信息。

PHP的WebSocket服务器和客户端库

维护者

详细信息

github.com/Devristo/phpws

源代码

安装次数: 294,712

依赖者: 13

建议者: 0

安全性: 0

星标: 340

关注者: 37

分支: 154

dev-master 2019-05-06 18:16 UTC

This package is auto-updated.

Last update: 2022-02-01 12:30:36 UTC


README

⛔️ 此项目不再维护 ⛔️

我们敦促您寻找替代方案。

描述

PHP的WebSocket服务器和客户端库。支持最新的HyBi规范,以及旧版Chrome版本和一些Flash回退解决方案使用的Hixie #76规范。

此项目开始是为了给http://www.u2start.com/带来更多交互功能。

功能

服务器

  • Hixie #76和Hybi #12协议版本
  • Flash客户端支持(也在同一端口上提供XML策略文件)
  • 原生Firefox、Safari(iPod / iPhone同样支持)、Chrome和IE10支持。带有Flash客户端,支持Flash的所有浏览器都可以正常工作(包括IE6-9、Opera、Android和其他旧桌面浏览器)。
  • Opera(移动版)原生支持WebSocket,但默认情况下已禁用支持。可以在opera:config中启用。

客户端

  • Hybi / Hixie76支持。
  • 基于事件的异步I/O

入门

最简单的方法是将PHPWS用作Composer依赖项。在您的composer.json中添加以下内容

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/Devristo/phpws"
        }
    ],
    "require": {
        "devristo/phpws": "dev-master"
    }
}

然后运行 php composer.phar install

为了验证它是否正常工作,在您的项目根目录中创建一个time.php

require_once("vendor/autoload.php");
use Devristo\Phpws\Server\WebSocketServer;

$loop = \React\EventLoop\Factory::create();

// Create a logger which writes everything to the STDOUT
$logger = new \Zend\Log\Logger();
$writer = new Zend\Log\Writer\Stream("php://output");
$logger->addWriter($writer);

// Create a WebSocket server using SSL
$server = new WebSocketServer("tcp://0.0.0.0:12345", $loop, $logger);

$loop->addPeriodicTimer(0.5, function() use($server, $logger){
    $time = new DateTime();
    $string = $time->format("Y-m-d H:i:s");
    $logger->notice("Broadcasting time to all clients: $string");
    foreach($server->getConnections() as $client)
        $client->sendString($string);
});


// Bind the server
$server->bind();

// Start the event loop
$loop->run();

并创建一个客户端time.html如下

<html>
    <head>
        <title>WebSocket TEST</title>
    </head>
    <body>
        <h1>Server Time</h1>
        <strong id="time"></strong>

        <script>
            var socket = new WebSocket("ws://localhost:12345/");
            socket.onmessage = function(msg) {
                document.getElementById("time").innerText = msg.data;
            };
        </script>
    </body>
</html>

现在从命令行运行time.php并在您的浏览器中打开time.html。您应该看到由phpws定期广播的当前时间。如果这样工作,您可能对示例文件夹中的更复杂的服务器感兴趣。

Phpws客户端入门

以下是一个托管在http://echo.websocket.org的websocket服务器的客户端。

require_once("vendor/autoload.php");                // Composer autoloader

$loop = \React\EventLoop\Factory::create();

$logger = new \Zend\Log\Logger();
$writer = new Zend\Log\Writer\Stream("php://output");
$logger->addWriter($writer);

$client = new \Devristo\Phpws\Client\WebSocket("ws://echo.websocket.org/?encoding=text", $loop, $logger);

$client->on("request", function($headers) use ($logger){
    $logger->notice("Request object created!");
});

$client->on("handshake", function() use ($logger) {
    $logger->notice("Handshake received!");
});

$client->on("connect", function($headers) use ($logger, $client){
    $logger->notice("Connected!");
    $client->send("Hello world!");
});

$client->on("message", function($message) use ($client, $logger){
    $logger->notice("Got message: ".$message->getData());
    $client->close();
});

$client->open();
$loop->run();

已知问题

  • 缺少ORIGIN检查(可以在onConnect中使用getHeaders()手动实现,当您不喜欢Origin头时断开用户连接)
  • 不支持HyBi规范中的扩展数据。

要求

服务器

  • PHP 5.4

  • 为服务器开放端口

  • PHP OpenSSL模块以在加密连接上运行服务器

  • http://pecl.php.net/package/pecl_http,因为它是Zend\Uri的依赖项

  • Composer依赖项 * 使用phpws作为Composer包时,这些依赖项将自动安装。

  • Reactphp

  • ZF2 Logger

客户端

  • PHP 5.4
  • 实现HyBi(#8-#12)草案版本的服务器
  • PHP OpenSSL模块以使用SSL(wss:// uris)连接