Gateway::sendToGroup
说明:
php
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 对数据不再做任何处理,直接发给客户端。
如果 $raw
为 true
,要求 $message
为用协议打包好的数据 (调用了 gateway 指定协议的 encode 方法生成的数据),否则客户端可能无法解析。
此参数一般用于某些特殊情况,例如合并多个数据包为一段 buffer,一次性发给客户端,而不是逐条发给客户端,这将有助于降低系统负载。
绝大多数情况此参数用不到,开发者可以忽略。
更新日志
版本 | 说明 |
---|---|
2.0.7 | 增加了 $exclude_client_id 和 $raw 参数 |
返回值
因为数据发送是异步进行的,所以没有返回值。一般来说只要客户端在线就可以发送成功。
范例
php
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']);
}
...
}