连接上下文

imi 中 WebSocket 服务中使用 Imi\ConnectContext 类对连接的会话数据进行管理。在整个连接的生命周期中都有效。

使用

use Imi\ConnectContext;

// 取值
echo ConnectContext::get('name');
echo ConnectContext::get('name', 'default value');

// 赋值
ConnectContext::set('name', 'value');

// 获取所有数据
$array = ConnectContext::getContext();

// 使用回调并且自动加锁进行操作，回调用返回数据会保存进连接上下文
ConnectContext::use(function($data){
    // 本方法体会在锁中执行
    var_dump($data); // 读取数据
    $data['aaa'] = 222;
    return $data; // 写入数据，不return也可以，就是不修改
});

配置

ConnectContext 存储器

Redis:

'beans' =>  [
    'ConnectContextStore'   =>  [
        'handlerClass'  =>  \Imi\Server\ConnectContext\StoreHandler\Redis::class,
    ],
    'ConnectContextRedis'    =>    [
        'redisPool'    => 'redis', // Redis 连接池名称
        'redisDb'      => 0, // redis中第几个库
        'key'          => 'imi:connect_context', // 键
        'heartbeatTimespan' => 5, // 心跳时间，单位：秒
        'heartbeatTtl' => 8, // 心跳数据过期时间，单位：秒
        'dataEncode'=>  'serialize', // 数据写入前编码回调
        'dataDecode'=>  'unserialize', // 数据读出后处理回调
        'lockId'    =>  null, // 必设，需要用锁来防止数据错乱问题
    ],
],

Local:

本地变量存储，性能最高

只建议在 SWOOLE_BASE 模式下使用

'beans' =>  [
    'ConnectContextStore'   =>  [
        'handlerClass'  =>  \Imi\Server\ConnectContext\StoreHandler\Local::class,
    ],
    'ConnectContextLocal'    =>    [
        'lockId'    =>  null, // 必设，需要用锁来防止数据错乱问题
    ],
],

MemoryTable:

'beans' =>  [
    'ConnectContextStore'   =>  [
        'handlerClass'  =>  \Imi\Server\ConnectContext\StoreHandler\MemoryTable::class,
    ],
    'ConnectContextMemoryTable' =>  [
        'tableName' =>  'connectContext', // tableName 你需要实现定义 MemoryTable，请查看相关章节
        'dataEncode'=>  'serialize', // 数据写入前编码回调
        'dataDecode'=>  'unserialize', // 数据读出后处理回调
        'lockId'    =>  null, // 非必设，因为如果用 MemoryTable，默认是用 MemoryTable 的 Lock
    ],
],

连接绑定器

'beans' =>  [
    // 连接绑定器
    'ConnectionBinder'  =>  [
        // 处理器类，默认 ConnectionBinderRedis
        // 支持：ConnectionBinderRedis、ConnectionBinderLocal
        // 'handlerClass' => 'ConnectionBinderRedis',
    ],
    // Redis 连接绑定器配置
    'ConnectionBinderRedis' => [
        // Redis 连接池名称
        'redisPool' =>  'redis',
        // redis中第几个库
        'redisDb'   =>  0,
        // 键，多个服务共用 redis 请设为不同的，不然会冲突
        'key'       =>  'imi:wsTest:connectionBinder:map',
    ],
    // 连接绑定器本地驱动
    'ConnectionBinderLocal' => [
        // 'gcInteval' => 60, // 清除旧的过期数据时间间隔，单位：秒
    ],
],

方法

获取当前连接号

use Imi\ConnectContext;

$fd = ConnectContext::getFd();

绑定连接

use Imi\ConnectContext;
$memberId = 1; // 用户标识符

ConnectContext::bind($memberId);

绑定连接，如果已绑定返回false

use Imi\ConnectContext;
$memberId = 1; // 用户标识符

ConnectContext::bindNx($memberId);

恢复连接数据

use Imi\ConnectContext;
$memberId = 1; // 用户标识符

ConnectContext::restore($memberId);

取消绑定

use Imi\ConnectContext;
$memberId = 1; // 用户标识符

ConnectContext::unbind($memberId);

使用标记（UID）获取连接编号

use Imi\ConnectContext;
$memberId = 1; // 用户标识符

$fd = ConnectContext::getFdByFlag($memberId);

【批量】使用标记（UID）获取连接编号

use Imi\ConnectContext;
$memberId = 1; // 用户标识符

$fds = ConnectContext::getFdsByFlags([$memberId]); // [1]

使用连接编号获取标记（UID）

use Imi\ConnectContext;
$fd = 1; // 连接编号

$memberIds = ConnectContext::getFlagByFd($fd);

【批量】使用连接编号获取标记（UID）

use Imi\ConnectContext;
$fd = 1; // 连接编号

$memberIds = ConnectContext::getFlagsByFds([$fd]); // [1]