feat(websocket): introduce WebSocket server implementation

Author: cclilshy

examples/10-websocket.php

@@ -0,0 +1,54 @@
+<?php declare(strict_types=1);
+
+/**
+ * Copyright © 2024 cclilshy
+ * Email: jingnigg@gmail.com
+ *
+ * This software is licensed under the MIT License.
+ * For full license details, please visit: https://opensource.org/licenses/MIT
+ *
+ * By using this software, you agree to the terms of the license.
+ * Contributions, suggestions, and feedback are always welcome!
+ */
+
+use Ripple\Net\WebSocket;
+use Ripple\Net\WebSocket\Server\Connection;
+
+use function Co\wait;
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+// 创建 WebSocket 服务器
+$server = WebSocket::server('ws://0.0.0.0:8001');
+
+if ($server instanceof Throwable) {
+    echo "Failed to create WebSocket server: " . $server->getMessage() . \PHP_EOL;
+    exit(1);
+}
+
+echo "WebSocket server started on ws://0.0.0.0:8001" . \PHP_EOL;
+
+$server->onRequest = function (mixed $request) {
+    \var_dump('on request');
+};
+
+$server->onConnect = function (Connection $connection) {
+    echo "New WebSocket connection established" . \PHP_EOL;
+
+    // 设置消息处理器
+    $connection->onMessage = function (string $message, Connection $conn) {
+        echo "Received message: " . $message . \PHP_EOL;
+        $conn->sendText("Echo: " . $message);
+    };
+
+    // 设置关闭处理器
+    $connection->onClose = function (Connection $conn) {
+        echo "WebSocket connection closed" . \PHP_EOL;
+    };
+
+    $connection->sendText("Welcome to WebSocket server!");
+};
+
+// 启动服务器
+$server->listen();
+wait();

src/Net/Http/Server.php

@@ -125,7 +125,7 @@ public function listen(): void
             $socket = socket_import_stream($client);
             socket_setopt($socket, SOL_TCP, TCP_NODELAY, 1);
             //            @socket_setopt($socket, SOL_SOCKET, SO_RCVBUF, 65536);
-            //            @socket_setopt($socket, SOL_SOCKET, SO_SNDBUF, 65536);
+            //            @socket_setopt($socket, SOL_SOCKET, SO_FINDBUGS, 65536);
 
             $remoteInfo = parse_url("tcp://{$remoteAddr}");
 

src/Net/Http/Server/Connection.php

@@ -244,17 +244,19 @@ private function onRequest(array $reqInfo): void
 
         // 半关闭检测
         $connHeader = $reqInfo['server']['HTTP_CONNECTION'] ?? '';
+        $upgradeHeader = $reqInfo['server']['HTTP_UPGRADE'] ?? '';
         $keepAlive = strtolower($connHeader) === 'keep-alive';
+        $isWebSocketUpgrade = strtolower($upgradeHeader) === 'websocket' &&
+                              str_contains(strtolower($connHeader), 'upgrade');
 
-        if ($keepAlive) {
-            $response->withHeader('Connection', 'keep-alive');
+        if ($keepAlive || $isWebSocketUpgrade) {
+            $response->withHeader('Connection', $keepAlive ? 'keep-alive' : 'Upgrade');
         } else {
             $response->withHeader('Connection', 'close');
             $this->stream->shutdownRead();
         }
 
         try {
-            //            call_user_func($this->httpServer->onRequest, $req);
             Scheduler::resume($this->httpServer->acquireCoroutine(), $req)->rethrow();
         } catch (ConnectionException $exception) {
             throw $exception;

src/Net/WebSocket.php

@@ -0,0 +1,50 @@
+<?php declare(strict_types=1);
+/**
+ * Copyright © 2024 cclilshy
+ * Email: jingnigg@gmail.com
+ *
+ * This software is licensed under the MIT License.
+ * For full license details, please visit: https://opensource.org/licenses/MIT
+ *
+ * By using this software, you agree to the terms of the license.
+ * Contributions, suggestions, and feedback are always welcome!
+ */
+
+namespace Ripple\Net;
+
+use Ripple\Net\WebSocket\Server\Server;
+use Ripple\Stream\Exception\ConnectionException;
+use Throwable;
+use RuntimeException;
+
+use function str_replace;
+
+class WebSocket
+{
+    /**
+     * 创建 WebSocket 服务器
+     * @param string $address 监听地址, 格式：ws://host:port 或 wss://host:port
+     * @param mixed|null $streamContext 流上下文选项
+     * @return Server|Throwable
+     */
+    public static function server(string $address, mixed $streamContext = null): Server|Throwable
+    {
+        try {
+            $httpAddress = self::convertToHttpAddress($address);
+            return new Server($httpAddress, $streamContext);
+        } catch (ConnectionException $e) {
+            throw new RuntimeException($e->getMessage(), $e->getCode(), $e);
+        }
+    }
+
+    /**
+     * @param string $wsAddress
+     * @return string
+     */
+    private static function convertToHttpAddress(string $wsAddress): string
+    {
+        $wsAddress = str_replace('ws://', 'http://', $wsAddress);
+        $wsAddress = str_replace('wss://', 'https://', $wsAddress);
+        return $wsAddress;
+    }
+}

src/Net/WebSocket/Enum/Opcode.php

@@ -0,0 +1,68 @@
+<?php declare(strict_types=1);
+/**
+ * Copyright © 2024 cclilshy
+ * Email: jingnigg@gmail.com
+ *
+ * This software is licensed under the MIT License.
+ * For full license details, please visit: https://opensource.org/licenses/MIT
+ *
+ * By using this software, you agree to the terms of the license.
+ * Contributions, suggestions, and feedback are always welcome!
+ */
+
+namespace Ripple\Net\WebSocket\Enum;
+
+use InvalidArgumentException;
+
+enum Opcode: int
+{
+    case CONTINUATION = 0x0;  // 继续帧
+    case TEXT = 0x1;         // 文本帧
+    case BINARY = 0x2;       // 二进制帧
+    case CLOSE = 0x8;        // 关闭帧
+    case PING = 0x9;         // ping 帧
+    case PONG = 0xA;         // pong 帧
+
+    /**
+     * 从整数值创建枚举
+     * @param int $value
+     * @return self
+     * @throws InvalidArgumentException
+     */
+    public static function fromValue(int $value): self
+    {
+        return match ($value) {
+            0x0 => self::CONTINUATION,
+            0x1 => self::TEXT,
+            0x2 => self::BINARY,
+            0x8 => self::CLOSE,
+            0x9 => self::PING,
+            0xA => self::PONG,
+            default => throw new InvalidArgumentException("Invalid opcode: {$value}")
+        };
+    }
+
+    /**
+     * 是否为控制帧
+     * @return bool
+     */
+    public function isControlFrame(): bool
+    {
+        return match ($this) {
+            self::CLOSE, self::PING, self::PONG => true,
+            default => false
+        };
+    }
+
+    /**
+     * 是否为数据帧
+     * @return bool
+     */
+    public function isDataFrame(): bool
+    {
+        return match ($this) {
+            self::TEXT, self::BINARY => true,
+            default => false
+        };
+    }
+}

src/Net/WebSocket/Exception/FrameException.php

@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+/**
+ * Copyright © 2024 cclilshy
+ * Email: jingnigg@gmail.com
+ *
+ * This software is licensed under the MIT License.
+ * For full license details, please visit: https://opensource.org/licenses/MIT
+ *
+ * By using this software, you agree to the terms of the license.
+ * Contributions, suggestions, and feedback are always welcome!
+ */
+
+namespace Ripple\Net\WebSocket\Exception;
+
+use RuntimeException;
+
+class FrameException extends RuntimeException
+{
+}