wtwt/yii2-websocket

使用yii2封装 websocket 扩展

安装: 5

依赖关系: 0

建议者: 0

安全: 0

星星: 0

关注者: 1

分支: 0

开放问题: 0

类型:yii2-extension

1.0.0 2024-05-21 09:25 UTC

This package is auto-updated.

Last update: 2024-09-22 07:48:27 UTC


README

在 yii2 下运行 WebSocket 服务。

Latest Stable Version Total Downloads License

驱动支持

安装

通过 composer 安装此扩展程序是首选方法。

编辑运行

php composer.phar require --prefer-dist wtwt/yii2-websocket "^1.0.0"

或添加配置到项目目录下的 composer.json 文件的 require 部分

"wtwt/yii2-websocket": "^1.0.0"

基本使用

每个 channel 的功能都需要定义一个单独的类。例如,如果你需要为指定客户端推送一条消息,则该类可能如下所示:

namespace xxx\channels;

class PushMessageChannel extends BaseObject implements \wtwt\websocket\ChannelInterface
{
	public function execute($fd, $data)
	{
		return [
			$fd, // 第一个参数返回客户端ID,多个以数组形式返回
			$data // 第二个参数返回需要返回给客户端的消息
		];
	}

	public function close($fd)
	{
		return;
	}
}

以下是发送消息到客户端的方法:

Yii::$app->websocket->send(['channel' => 'push-message', 'message' => '用户 xxx 送了一台飞机!']);

执行任务的准确方式取决于所使用的驱动程序。大多数驱动程序可以通过控制台命令运行,组件需要在应用程序中注册。

此命令启动一个守护进程,该守护进程维护一个 WebSocket Server,并根据客户端发送的数据处理相关 channel 的任务:

yii websocket/start

有关特定驱动程序的更多详细信息,包括控制台命令及其选项,请参阅 文档