Gateway::sendToGroup

说明:

void Gateway::sendToGroup(mixed $group, string $message [, array $exclude_client_id = null [, bool $raw = false]]);

向某个分组的所有在线client_id发送数据。

参数

  • $group

group可以是字符串、数字、或者数组。如果为数组,则是给数组内所有group发送数据

  • $message

要发送的数据(字符串类型),此数据会被Gateway所使用协议的encode方法打包后再发送给客户端

  • $exclude_client_id

client_id组成的数组。$exclude_client_id数组中指定的client_id将被排除在外,不会收到本次发的消息

  • $raw

是否发送原始数据,也就是绕过gateway协议打包过程,gateway对数据不再做任何处理,直接发给客户端。

如果$rawtrue,要求$message为用协议打包好的数据(调用了gateway指定协议的encode方法生成的数据),否则客户端可能无法解析。

此参数一般用于某些特殊情况,例如合并多个数据包为一段buffer,一次性发给客户端,而不是逐条发给客户端,这将有助于降低系统负载。

绝大多数情况此参数用不到,开发者可以忽略。

更新日志

版本 说明
2.0.7 增加了$exclude_client_id$raw参数

返回值

因为数据发送是异步进行的,所以没有返回值。一般来说只要客户端在线就可以发送成功。

范例

use \GatewayWorker\Lib\Gateway;
class Events
{
    ...

    public static function onMessage($client_id, $message)
    {
        // $message = '{"type":"send_to_group","group":"xxxxx", "message":"...."}'
        $req_data = json_decode($message, true);
        Gateway::sendToGroup($req_data['group'], $req_data['message']);
    }

    ...
}

results matching ""

    No results matching ""