Skip to content

Gateway::getAllGroupIdList

说明:

php
array Gateway::getAllGroupIdList(void);

(要求Gateway版本>=3.0.8) 如何查看 Gateway 版本

获取全局所有在线 group id 列表。

返回值

返回 group id 为 key 同时 group id 为值的数组。 类似下面的格式

php
array(
    'room-1' => 'room-1',
    'room-2' => 'room-2'
)

注意:如果是客户端断网断电等极端情况掉线,客户端的 onClose 回调可能无法及时触发,参见 onClose 说明。也就是说对应客户端出现断网断电等极端掉线情况返回值中可能包含了不准确的数据。这种情况需要心跳来检测已经掉线的客户端。

范例

php
use \GatewayWorker\Lib\Gateway;

class Events
{
    ...
    public onMessage($client_id, $message)
    {
        $group = 'room-1';
        Gateway::joinGroup($client_id, $group);
        var_export(Gateway::getAllGroupIdList());
    }
    ...
}

打印出的数据类似如下:

php
array(
    'room-1' => 'room-1',
    'room-2' => 'room-2'
)

基于 MIT 许可发布