<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The Swoole\Redis\Server class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="swoole-process.write.html">Swoole\Process::write</a></div>
<div class="next" style="text-align: right; float: right;"><a href="swoole-redis-server.format.html">Swoole\Redis\Server::format</a></div>
<div class="up"><a href="book.swoole.html">Swoole</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.swoole-redis-server" class="reference">
<h1 class="title">The Swoole\Redis\Server class</h1>
<div class="partintro"><p class="verinfo">(PHP 5 >= 5.2.0, PHP 7, PECL swoole >= 1.9.0)</p>
<div class="section" id="swoole-redis-server.intro">
<h2 class="title">Introduction</h2>
<p class="para">
</p>
</div>
<div class="section" id="swoole-redis-server.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Swoole\Redis\Server</strong>
</span>
<span class="ooclass">
<span class="modifier">extends</span>
<a href="class.swoole-server.html" class="classname">Swoole\Server</a>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.swoole-redis-server.html#swoole-redis-server.constants.nil"><var class="varname">NIL</var></a></var>
<span class="initializer"> = 1</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.swoole-redis-server.html#swoole-redis-server.constants.error"><var class="varname">ERROR</var></a></var>
<span class="initializer"> = 0</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.swoole-redis-server.html#swoole-redis-server.constants.status"><var class="varname">STATUS</var></a></var>
<span class="initializer"> = 2</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.swoole-redis-server.html#swoole-redis-server.constants.int"><var class="varname">INT</var></a></var>
<span class="initializer"> = 3</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.swoole-redis-server.html#swoole-redis-server.constants.string"><var class="varname">STRING</var></a></var>
<span class="initializer"> = 4</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.swoole-redis-server.html#swoole-redis-server.constants.set"><var class="varname">SET</var></a></var>
<span class="initializer"> = 5</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">integer</span>
<var class="fieldsynopsis_varname"><a href="class.swoole-redis-server.html#swoole-redis-server.constants.map"><var class="varname">MAP</var></a></var>
<span class="initializer"> = 6</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">ReturnType</span> <span class="methodname"><a href="swoole-redis-server.format.html" class="methodname">format</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$type</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="swoole-redis-server.sethandler.html" class="methodname">setHandler</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$command</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$callback</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$number_of_string_param</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$type_of_array_param</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="swoole-redis-server.start.html" class="methodname">start</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Inherited methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.addlistener.html" class="methodname">Swoole\Server::addlistener</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$port</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$socket_type</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.addprocess.html" class="methodname">Swoole\Server::addProcess</a></span>
( <span class="methodparam"><span class="type"><a href="class.swoole-process.html" class="type swoole_process">swoole_process</a></span> <code class="parameter">$process</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="swoole-server.after.html" class="methodname">Swoole\Server::after</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$after_time_ms</code></span>
, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$param</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.bind.html" class="methodname">Swoole\Server::bind</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$uid</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.cleartimer.html" class="methodname">Swoole\Server::clearTimer</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$timer_id</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="type">void</span> <span class="methodname"><strong>swoole_timer_clear</strong></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$timer_id</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.close.html" class="methodname">Swoole\Server::close</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
[, <span class="methodparam"><span class="type">boolean</span> <code class="parameter">$reset</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.confirm.html" class="methodname">Swoole\Server::confirm</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="swoole-server.connection-info.html" class="methodname">Swoole\Server::connection_info</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
[, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$reactor_id</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="swoole-server.connection-list.html" class="methodname">Swoole\Server::connection_list</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$start_fd</code></span>
[, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$pagesize</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.defer.html" class="methodname">Swoole\Server::defer</a></span>
( <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server-port.destruct.html" class="methodname">Swoole\Server\Port::__destruct</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="swoole-server-port.on.html" class="methodname">Swoole\Server\Port::on</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$event_name</code></span>
, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server-port.set.html" class="methodname">Swoole\Server\Port::set</a></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$settings</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.exist.html" class="methodname">Swoole\Server::exist</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.finish.html" class="methodname">Swoole\Server::finish</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="swoole-server.getclientinfo.html" class="methodname">Swoole\Server::getClientInfo</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
[, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$reactor_id</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="swoole-server.getclientlist.html" class="methodname">Swoole\Server::getClientList</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$start_fd</code></span>
[, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$pagesize</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">integer</span> <span class="methodname"><a href="swoole-server.getlasterror.html" class="methodname">Swoole\Server::getLastError</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="swoole-server.heartbeat.html" class="methodname">Swoole\Server::heartbeat</a></span>
( <span class="methodparam"><span class="type">boolean</span> <code class="parameter">$if_close_connection</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.listen.html" class="methodname">Swoole\Server::listen</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$host</code></span>
, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$port</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$socket_type</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.on.html" class="methodname">Swoole\Server::on</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$event_name</code></span>
, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.pause.html" class="methodname">Swoole\Server::pause</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.protect.html" class="methodname">Swoole\Server::protect</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
[, <span class="methodparam"><span class="type">boolean</span> <code class="parameter">$is_protected</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.reload.html" class="methodname">Swoole\Server::reload</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.resume.html" class="methodname">Swoole\Server::resume</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.send.html" class="methodname">Swoole\Server::send</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
[, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$reactor_id</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.sendfile.html" class="methodname">Swoole\Server::sendfile</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$offset</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.sendmessage.html" class="methodname">Swoole\Server::sendMessage</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$worker_id</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.sendto.html" class="methodname">Swoole\Server::sendto</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$ip</code></span>
, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$port</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$server_socket</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.sendwait.html" class="methodname">Swoole\Server::sendwait</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$fd</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">ReturnType</span> <span class="methodname"><a href="swoole-server.set.html" class="methodname">Swoole\Server::set</a></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$settings</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.shutdown.html" class="methodname">Swoole\Server::shutdown</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.start.html" class="methodname">Swoole\Server::start</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="swoole-server.stats.html" class="methodname">Swoole\Server::stats</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">boolean</span> <span class="methodname"><a href="swoole-server.stop.html" class="methodname">Swoole\Server::stop</a></span>
([ <span class="methodparam"><span class="type">integer</span> <code class="parameter">$worker_id</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">mixed</span> <span class="methodname"><a href="swoole-server.task.html" class="methodname">Swoole\Server::task</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
[, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$dst_worker_id</code></span>
[, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.taskwait.html" class="methodname">Swoole\Server::taskwait</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$data</code></span>
[, <span class="methodparam"><span class="type">float</span> <code class="parameter">$timeout</code></span>
[, <span class="methodparam"><span class="type">integer</span> <code class="parameter">$worker_id</code></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.taskwaitmulti.html" class="methodname">Swoole\Server::taskWaitMulti</a></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$tasks</code></span>
[, <span class="methodparam"><span class="type">double</span> <code class="parameter">$timeout_ms</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="swoole-server.tick.html" class="methodname">Swoole\Server::tick</a></span>
( <span class="methodparam"><span class="type">integer</span> <code class="parameter">$interval_ms</code></span>
, <span class="methodparam"><span class="type"><a href="language.types.callable.html" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>
)</div>
}</div>
</div>
<div class="section" id="swoole-redis-server.constants">
<h2 class="title">Predefined Constants</h2>
<dl>
<dt id="swoole-redis-server.constants.nil"><strong><code>Swoole\Redis\Server::NIL</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="swoole-redis-server.constants.error"><strong><code>Swoole\Redis\Server::ERROR</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="swoole-redis-server.constants.status"><strong><code>Swoole\Redis\Server::STATUS</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="swoole-redis-server.constants.int"><strong><code>Swoole\Redis\Server::INT</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="swoole-redis-server.constants.string"><strong><code>Swoole\Redis\Server::STRING</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="swoole-redis-server.constants.set"><strong><code>Swoole\Redis\Server::SET</code></strong></dt>
<dd>
<p class="para"/>
</dd>
<dt id="swoole-redis-server.constants.map"><strong><code>Swoole\Redis\Server::MAP</code></strong></dt>
<dd>
<p class="para"/>
</dd>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="swoole-redis-server.format.html">Swoole\Redis\Server::format</a> — Description</li><li><a href="swoole-redis-server.sethandler.html">Swoole\Redis\Server::setHandler</a> — Description</li><li><a href="swoole-redis-server.start.html">Swoole\Redis\Server::start</a> — Description</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="swoole-process.write.html">Swoole\Process::write</a></div>
<div class="next" style="text-align: right; float: right;"><a href="swoole-redis-server.format.html">Swoole\Redis\Server::format</a></div>
<div class="up"><a href="book.swoole.html">Swoole</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
