\swoole_redis

class swoole_redis

Summary

Methods
Properties
Constants
__construct()
isConnected()
setConnectTimeout()
setQueryTimeout()
on()
connect()
close()
__call()
$errCode
$sock
$port
$errMsg
$host
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$errCode

$errCode : integer

执行命令的错误码

Type

integer

$sock

$sock : integer

连接使用的文件描述符

Type

integer

$port

$port : integer

redis服务器的端口

Type

integer

$errMsg

$errMsg : string

执行命令的错误信息

Type

string

$host

$host : string

redis服务器的 ip 地址

Type

string

Methods

__construct()

__construct() 

__construct Redis 客户端对象构造函数

isConnected()

isConnected() : boolean

isConnected 判断连接是否正常

Returns

boolean —

true 处于连接状态,false 非连接状态

setConnectTimeout()

setConnectTimeout(integer  $timeout) : boolean

setConnectTimeout 设置连接超时时间,可重复设置,以最后一次设置为准

Parameters

integer $timeout

超时时间,单位ms,设置为0时,不超时

Returns

boolean —

设置成功返回true,设置失败返回false

setQueryTimeout()

setQueryTimeout(integer  $timeout) : boolean

setQueryTimeout 设置消息发送超时时间,可重复设置,以最后一次设置为准,仅对非订阅消息生效

Parameters

integer $timeout

超时时间,单位ms,设置为0时,不超时

Returns

boolean —

设置成功返回true,设置失败返回false

on()

on(string  $event_name, callable  $callback) : boolean

on

Parameters

string $event_name

redis 服务回调事件名称,目前只支持两种事件 onClose、onMessage

"close"      // 连接关闭事件
"message"    // 订阅消息事件
callable $callback

事件回调函数,参见onClose/onMessage

连接关闭事件回调函数
param swoole_redis $redis redis对象

function onClose(swoole_redis $redis);
订阅消息回调
param swoole_redis $redis redis对象
param array $message      消息内容

订阅/发布指令没有回调函数,不需要在最后一个参数传入callback
使用订阅/发布消息命名,必须设置onMessage事件回调函数
客户端发出了subscribe命令后,只能执行
subscribe, psubscribe,unsubscribe,punsubscribe 这 4 条命令

function onMessage(swoole_redis $redis, array $message);

Returns

boolean —

成功返回 true,失败返回 false

connect()

connect(string  $host, integer  $port, callable  $callback) : boolean

connect 连接到 Redis 服务端

Parameters

string $host

redis 服务器 ip 地址

integer $port

redis 服务器监听的端口 port

callable $callback

连接成功后的回调函数,函数原型参考onConnect

连接事件回调
function onConnect(swoole_redis $redis, bool $result);
                   swoole_redis $redis redis对象
                   bool $result 连接结果,true 连接成功,false 连接失败

Returns

boolean —

true接口调用成功,false接口调用失败

close()

close() : boolean

close 关闭 Redis 连接

Returns

boolean —

成功返回 true,失败返回 false

__call()

__call(string  $command, array  $params) : boolean

__call 魔术方法,方法名会映射为Redis指令,参数作为Redis指令的参数。

Parameters

string $command

调用函数名

 调用函数名如 get、set、hset,必须为合法的 Redis 指令,subscribe 类型的命令除外
array $params

函数对应的参数列表 列表最后的元素是结果回调函数, 参见,onResult; 其它参数必须为字符串。

void onResult(swoole_redis $redis,mixed $result)

Returns

boolean —

成功返回 true,失败返回 false