| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=gbk" />
- <meta name="language" content="zh-cn" />
- <link rel="stylesheet" type="text/css" href="css/style.css" />
- <link rel="stylesheet" type="text/css" href="css/api.css" />
- <script type="text/javascript" src="js/jquery.js"></script>
- <title>XSServer</title>
- </head>
- <body>
- <div id="apiPage">
- <div id="apiHeader">
- <a href="http://www.xunsearch.com" target="_blank">Xunsearch PHP-SDK</a> v1.3.2 API 参考文档
- </div><!-- end of header -->
- <div id="content" class="api-index">
- <h1>XSServer</h1>
- <div id="nav">
- <a href="index.html">All Packages</a>
- | <a href="#properties">属性</a>
- | <a href="#methods">方法(函数)</a>
- </div>
- <table class="summaryTable docClass">
- <colgroup>
- <col class="col-name" />
- <col class="col-value" />
- </colgroup>
- <tr>
- <th>包</th>
- <td><a href="index.html#XS">XS</a></td>
- </tr>
- <tr>
- <th>继承关系</th>
- <td>class XSServer »
- <a href="XSComponent.html">XSComponent</a></td>
- </tr>
- <tr>
- <th>子类</th>
- <td><a href="XSIndex.html">XSIndex</a>, <a href="XSSearch.html">XSSearch</a></td>
- </tr>
- <tr>
- <th>版本</th>
- <td>1.0.0</td>
- </tr>
- <tr>
- <th>源代码</th>
- <td><a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php">sdk/php/lib/XSServer.class.php</a></td>
- </tr>
- </table>
- <div id="classDescription">
- XSServer 服务器操作对象
- 同时兼容于 indexd, searchd, 所有交互均采用 <a href="XSCommand.html">XSCommand</a> 对象</div>
- <a name="properties"></a>
- <div class="summary docProperty">
- <h2>Public 属性</h2>
- <p><a href="#" class="toggle">隐去继承来的属性</a></p>
- <table class="summaryTable">
- <colgroup>
- <col class="col-property" />
- <col class="col-type" />
- <col class="col-description" />
- <col class="col-defined" />
- </colgroup>
- <tr>
- <th>名称</th><th>类型</th><th>描述</th><th>定义于</th>
- </tr>
- <tr id="project">
- <td><a href="XSServer.html#project-detail">project</a></td>
- <td>string</td>
- <td>获取当前项目名称</td>
- <td>XSServer</td>
- </tr>
- <tr id="respond">
- <td><a href="XSServer.html#respond-detail">respond</a></td>
- <td><a href="XSCommand.html">XSCommand</a></td>
- <td>从服务器读取响应指令</td>
- <td>XSServer</td>
- </tr>
- <tr id="socket">
- <td><a href="XSServer.html#socket-detail">socket</a></td>
- <td>mixed</td>
- <td>获取连接资源描述符</td>
- <td>XSServer</td>
- </tr>
- <tr id="xs">
- <td><a href="XSServer.html#xs-detail">xs</a></td>
- <td><a href="XS.html">XS</a></td>
- <td>服务端关联的 XS 对象</td>
- <td>XSServer</td>
- </tr>
- </table>
- </div>
- <a name="methods"></a>
- <div class="summary docMethod">
- <h2>Public 方法</h2>
- <p><a href="#" class="toggle">隐去继承来的方法</a></p>
- <table class="summaryTable">
- <colgroup>
- <col class="col-method" />
- <col class="col-description" />
- <col class="col-defined" />
- </colgroup>
- <tr>
- <th>名称</th><th>描述</th><th>定义于</th>
- </tr>
- <tr id="__construct">
- <td><a href="XSServer.html#__construct-detail">__construct()</a></td>
- <td>构造函数, 打开连接</td>
- <td>XSServer</td>
- </tr>
- <tr id="__destruct">
- <td><a href="XSServer.html#__destruct-detail">__destruct()</a></td>
- <td>析构函数, 关闭连接</td>
- <td>XSServer</td>
- </tr>
- <tr class="inherited" id="__get">
- <td><a href="XSComponent.html#__get-detail">__get()</a></td>
- <td>魔术方法 __get</td>
- <td><a href="XSComponent.html">XSComponent</a></td>
- </tr>
- <tr class="inherited" id="__isset">
- <td><a href="XSComponent.html#__isset-detail">__isset()</a></td>
- <td>魔术方法 __isset</td>
- <td><a href="XSComponent.html">XSComponent</a></td>
- </tr>
- <tr class="inherited" id="__set">
- <td><a href="XSComponent.html#__set-detail">__set()</a></td>
- <td>魔术方法 __set</td>
- <td><a href="XSComponent.html">XSComponent</a></td>
- </tr>
- <tr class="inherited" id="__unset">
- <td><a href="XSComponent.html#__unset-detail">__unset()</a></td>
- <td>魔术方法 __unset</td>
- <td><a href="XSComponent.html">XSComponent</a></td>
- </tr>
- <tr id="close">
- <td><a href="XSServer.html#close-detail">close()</a></td>
- <td>关闭连接</td>
- <td>XSServer</td>
- </tr>
- <tr id="execCommand">
- <td><a href="XSServer.html#execCommand-detail">execCommand()</a></td>
- <td>执行服务端指令并获取返回值</td>
- <td>XSServer</td>
- </tr>
- <tr id="getProject">
- <td><a href="XSServer.html#getProject-detail">getProject()</a></td>
- <td>获取当前项目名称</td>
- <td>XSServer</td>
- </tr>
- <tr id="getRespond">
- <td><a href="XSServer.html#getRespond-detail">getRespond()</a></td>
- <td>从服务器读取响应指令</td>
- <td>XSServer</td>
- </tr>
- <tr id="getSocket">
- <td><a href="XSServer.html#getSocket-detail">getSocket()</a></td>
- <td>获取连接资源描述符</td>
- <td>XSServer</td>
- </tr>
- <tr id="hasRespond">
- <td><a href="XSServer.html#hasRespond-detail">hasRespond()</a></td>
- <td>判断服务端是否有可读数据</td>
- <td>XSServer</td>
- </tr>
- <tr id="open">
- <td><a href="XSServer.html#open-detail">open()</a></td>
- <td>打开服务端连接</td>
- <td>XSServer</td>
- </tr>
- <tr id="reopen">
- <td><a href="XSServer.html#reopen-detail">reopen()</a></td>
- <td>重新打开连接</td>
- <td>XSServer</td>
- </tr>
- <tr id="sendCommand">
- <td><a href="XSServer.html#sendCommand-detail">sendCommand()</a></td>
- <td>往服务器直接发送指令 (无缓存)</td>
- <td>XSServer</td>
- </tr>
- <tr id="setProject">
- <td><a href="XSServer.html#setProject-detail">setProject()</a></td>
- <td>设置当前项目</td>
- <td>XSServer</td>
- </tr>
- <tr id="setTimeout">
- <td><a href="XSServer.html#setTimeout-detail">setTimeout()</a></td>
- <td>设置服务端超时秒数</td>
- <td>XSServer</td>
- </tr>
- </table>
- </div>
- <a name="events"></a>
- <h2>属性明细</h2>
- <div class="detailHeader" id="project-detail">
- project<span class="detailHeaderTag">
- 属性
- </span>
- </div>
- <div class="signature">
- public string <a href="XSServer.html#getProject"><b>getProject</b></a>()<br/>public void <a href="XSServer.html#setProject"><b>setProject</b></a>(string $name, string $home='')</div>
- <p>获取当前项目名称</p>
- <div class="detailHeader" id="respond-detail">
- respond<span class="detailHeaderTag">
- 属性
- <em>只读</em> </span>
- </div>
- <div class="signature">
- public <a href="XSCommand.html">XSCommand</a> <a href="XSServer.html#getRespond"><b>getRespond</b></a>()</div>
- <p>从服务器读取响应指令</p>
- <div class="detailHeader" id="socket-detail">
- socket<span class="detailHeaderTag">
- 属性
- <em>只读</em> </span>
- </div>
- <div class="signature">
- public mixed <a href="XSServer.html#getSocket"><b>getSocket</b></a>()</div>
- <p>获取连接资源描述符</p>
- <div class="detailHeader" id="xs-detail">
- xs<span class="detailHeaderTag">
- 属性
- </span>
- </div>
- <div class="signature">
- public <a href="XS.html">XS</a> <b>$xs</b>;</div>
- <p>服务端关联的 XS 对象</p>
- <h2>方法明细</h2>
- <div class="detailHeader" id="__construct-detail">
- __construct()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public void <b>__construct</b>(string $conn=NULL, <a href="XS.html">XS</a> $xs=NULL)</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$conn</td>
- <td class="paramTypeCol">string</td>
- <td class="paramDescCol">服务端连接参数</td>
- </tr>
- <tr>
- <td class="paramNameCol">$xs</td>
- <td class="paramTypeCol"><a href="XS.html">XS</a></td>
- <td class="paramDescCol">需要捆绑的 xs 对象</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L140">sdk/php/lib/XSServer.class.php#L140</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">__construct</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">null</span><span style="color: #007700">, </span><span style="color: #0000BB">$xs </span><span style="color: #007700">= </span><span style="color: #0000BB">null</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">xs </span><span style="color: #007700">= </span><span style="color: #0000BB">$xs</span><span style="color: #007700">;<br /> if (</span><span style="color: #0000BB">$conn </span><span style="color: #007700">!== </span><span style="color: #0000BB">null</span><span style="color: #007700">)<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br />}</span>
- </span>
- </code></div>
- </div>
- <p>构造函数, 打开连接</p>
- <div class="detailHeader" id="__destruct-detail">
- __destruct()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public void <b>__destruct</b>()</div>
- </td></tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L150">sdk/php/lib/XSServer.class.php#L150</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">__destruct</span><span style="color: #007700">()<br />{<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">xs </span><span style="color: #007700">= </span><span style="color: #0000BB">null</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br />}</span>
- </span>
- </code></div>
- </div>
- <p>析构函数, 关闭连接</p>
- <div class="detailHeader" id="close-detail">
- close()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public void <b>close</b>(bool $ioerr=false)</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$ioerr</td>
- <td class="paramTypeCol">bool</td>
- <td class="paramDescCol">关闭调用是否由于 IO 错误引起的, 以免发送 quit 指令</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L192">sdk/php/lib/XSServer.class.php#L192</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">close</span><span style="color: #007700">(</span><span style="color: #0000BB">$ioerr </span><span style="color: #007700">= </span><span style="color: #0000BB">false</span><span style="color: #007700">)<br />{<br /> if (</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sock </span><span style="color: #007700">&& !(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_flag </span><span style="color: #007700">& </span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">BROKEN</span><span style="color: #007700">))<br /> {<br /> if (!</span><span style="color: #0000BB">$ioerr </span><span style="color: #007700">&& </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sendBuffer </span><span style="color: #007700">!== </span><span style="color: #DD0000">''</span><span style="color: #007700">)<br /> {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">write</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sendBuffer</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sendBuffer </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /> }<br /> if (!</span><span style="color: #0000BB">$ioerr </span><span style="color: #007700">&& !(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_flag </span><span style="color: #007700">& </span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">FILE</span><span style="color: #007700">))<br /> {<br /> </span><span style="color: #0000BB">$cmd </span><span style="color: #007700">= new </span><span style="color: #0000BB">XSCommand</span><span style="color: #007700">(</span><span style="color: #0000BB">CMD_QUIT</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">fwrite</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sock</span><span style="color: #007700">, </span><span style="color: #0000BB">$cmd</span><span style="color: #007700">);<br /> }<br /> </span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sock</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_flag </span><span style="color: #007700">|= </span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">BROKEN</span><span style="color: #007700">;<br /> }<br />}</span>
- </span>
- </code></div>
- </div>
- <p>关闭连接
- 附带发送发送 quit 命令</p>
- <div class="detailHeader" id="execCommand-detail">
- execCommand()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public mixed <b>execCommand</b>(mixed $cmd, int $res_arg=0, int $res_cmd=128)</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$cmd</td>
- <td class="paramTypeCol">mixed</td>
- <td class="paramDescCol">要提交的指令, 若不是 XSCommand 实例则作为构造函数的第一参数创建对象</td>
- </tr>
- <tr>
- <td class="paramNameCol">$res_arg</td>
- <td class="paramTypeCol">int</td>
- <td class="paramDescCol">要求的响应参数, 默认为 CMD_NONE 即不检测, 若检测结果不符
- 则认为命令调用失败, 会返回 false 并设置相应的出错信息</td>
- </tr>
- <tr>
- <td class="paramNameCol">$res_cmd</td>
- <td class="paramTypeCol">int</td>
- <td class="paramDescCol">要求的响应指令, 默认为 CMD_OK 即要求结果必须正确.</td>
- </tr>
- <tr>
- <td class="paramNameCol">{return}</td>
- <td class="paramTypeCol">mixed</td>
- <td class="paramDescCol">若无需要检测结果则返回 true, 其它返回响应的 XSCommand 对象</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L263">sdk/php/lib/XSServer.class.php#L263</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">execCommand</span><span style="color: #007700">(</span><span style="color: #0000BB">$cmd</span><span style="color: #007700">, </span><span style="color: #0000BB">$res_arg </span><span style="color: #007700">= </span><span style="color: #0000BB">CMD_NONE</span><span style="color: #007700">, </span><span style="color: #0000BB">$res_cmd </span><span style="color: #007700">= </span><span style="color: #0000BB">CMD_OK</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #FF8000">// create command object<br /> </span><span style="color: #007700">if (!</span><span style="color: #0000BB">$cmd </span><span style="color: #007700">instanceof </span><span style="color: #0000BB">XSCommand</span><span style="color: #007700">)<br /> </span><span style="color: #0000BB">$cmd </span><span style="color: #007700">= new </span><span style="color: #0000BB">XSCommand</span><span style="color: #007700">(</span><span style="color: #0000BB">$cmd</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// just cache the cmd for those need not answer<br /> </span><span style="color: #007700">if (</span><span style="color: #0000BB">$cmd</span><span style="color: #007700">-></span><span style="color: #0000BB">cmd </span><span style="color: #007700">& </span><span style="color: #0000BB">0x80</span><span style="color: #007700">)<br /> {<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sendBuffer </span><span style="color: #007700">.= </span><span style="color: #0000BB">$cmd</span><span style="color: #007700">;<br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> }<br /><br /> </span><span style="color: #FF8000">// send cmd to server<br /> </span><span style="color: #0000BB">$buf </span><span style="color: #007700">= </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sendBuffer </span><span style="color: #007700">. </span><span style="color: #0000BB">$cmd</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sendBuffer </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">write</span><span style="color: #007700">(</span><span style="color: #0000BB">$buf</span><span style="color: #007700">);<br /><br /> </span><span style="color: #FF8000">// return true directly for local file<br /> </span><span style="color: #007700">if (</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_flag </span><span style="color: #007700">& </span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">FILE</span><span style="color: #007700">)<br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /><br /> </span><span style="color: #FF8000">// got the respond<br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">getRespond</span><span style="color: #007700">();<br /><br /> </span><span style="color: #FF8000">// check respond<br /> </span><span style="color: #007700">if (</span><span style="color: #0000BB">$res</span><span style="color: #007700">-></span><span style="color: #0000BB">cmd </span><span style="color: #007700">=== </span><span style="color: #0000BB">CMD_ERR </span><span style="color: #007700">&& </span><span style="color: #0000BB">$res_cmd </span><span style="color: #007700">!= </span><span style="color: #0000BB">CMD_ERR</span><span style="color: #007700">)<br /> throw new </span><span style="color: #0000BB">XSException</span><span style="color: #007700">(</span><span style="color: #0000BB">$res</span><span style="color: #007700">-></span><span style="color: #0000BB">buf</span><span style="color: #007700">, </span><span style="color: #0000BB">$res</span><span style="color: #007700">-></span><span style="color: #0000BB">arg</span><span style="color: #007700">);<br /> </span><span style="color: #FF8000">// got unexpected respond command<br /> </span><span style="color: #007700">if (</span><span style="color: #0000BB">$res</span><span style="color: #007700">-></span><span style="color: #0000BB">cmd </span><span style="color: #007700">!= </span><span style="color: #0000BB">$res_cmd </span><span style="color: #007700">|| (</span><span style="color: #0000BB">$res_arg </span><span style="color: #007700">!= </span><span style="color: #0000BB">CMD_NONE </span><span style="color: #007700">&& </span><span style="color: #0000BB">$res</span><span style="color: #007700">-></span><span style="color: #0000BB">arg </span><span style="color: #007700">!= </span><span style="color: #0000BB">$res_arg</span><span style="color: #007700">))<br /> throw new </span><span style="color: #0000BB">XSException</span><span style="color: #007700">(</span><span style="color: #DD0000">'Unexpected respond {CMD:' </span><span style="color: #007700">. </span><span style="color: #0000BB">$res</span><span style="color: #007700">-></span><span style="color: #0000BB">cmd </span><span style="color: #007700">. </span><span style="color: #DD0000">', ARG:' </span><span style="color: #007700">. </span><span style="color: #0000BB">$res</span><span style="color: #007700">-></span><span style="color: #0000BB">arg </span><span style="color: #007700">. </span><span style="color: #DD0000">'}'</span><span style="color: #007700">);<br /> return </span><span style="color: #0000BB">$res</span><span style="color: #007700">;<br />}</span>
- </span>
- </code></div>
- </div>
- <p>执行服务端指令并获取返回值</p>
- <div class="detailHeader" id="getProject-detail">
- getProject()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public string <b>getProject</b>()</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">{return}</td>
- <td class="paramTypeCol">string</td>
- <td class="paramDescCol">项目名称</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L224">sdk/php/lib/XSServer.class.php#L224</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">getProject</span><span style="color: #007700">()<br />{<br /> return </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_project</span><span style="color: #007700">;<br />}</span>
- </span>
- </code></div>
- </div>
- <p>获取当前项目名称</p>
- <div class="detailHeader" id="getRespond-detail">
- getRespond()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public <a href="XSCommand.html">XSCommand</a> <b>getRespond</b>()</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">{return}</td>
- <td class="paramTypeCol"><a href="XSCommand.html">XSCommand</a></td>
- <td class="paramDescCol">成功返回响应指令</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L314">sdk/php/lib/XSServer.class.php#L314</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">getRespond</span><span style="color: #007700">()<br />{<br /> </span><span style="color: #FF8000">// read data from server<br /> </span><span style="color: #0000BB">$buf </span><span style="color: #007700">= </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">read</span><span style="color: #007700">(</span><span style="color: #0000BB">8</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$hdr </span><span style="color: #007700">= </span><span style="color: #0000BB">unpack</span><span style="color: #007700">(</span><span style="color: #DD0000">'Ccmd/Carg1/Carg2/Cblen1/Iblen'</span><span style="color: #007700">, </span><span style="color: #0000BB">$buf</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= new </span><span style="color: #0000BB">XSCommand</span><span style="color: #007700">(</span><span style="color: #0000BB">$hdr</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$res</span><span style="color: #007700">-></span><span style="color: #0000BB">buf </span><span style="color: #007700">= </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">read</span><span style="color: #007700">(</span><span style="color: #0000BB">$hdr</span><span style="color: #007700">[</span><span style="color: #DD0000">'blen'</span><span style="color: #007700">]);<br /> </span><span style="color: #0000BB">$res</span><span style="color: #007700">-></span><span style="color: #0000BB">buf1 </span><span style="color: #007700">= </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">read</span><span style="color: #007700">(</span><span style="color: #0000BB">$hdr</span><span style="color: #007700">[</span><span style="color: #DD0000">'blen1'</span><span style="color: #007700">]);<br /> return </span><span style="color: #0000BB">$res</span><span style="color: #007700">;<br />}</span>
- </span>
- </code></div>
- </div>
- <p>从服务器读取响应指令</p>
- <div class="detailHeader" id="getSocket-detail">
- getSocket()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public mixed <b>getSocket</b>()</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">{return}</td>
- <td class="paramTypeCol">mixed</td>
- <td class="paramDescCol">连接标识, 仅用于内部测试等目的</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L215">sdk/php/lib/XSServer.class.php#L215</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">getSocket</span><span style="color: #007700">()<br />{<br /> return </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sock</span><span style="color: #007700">;<br />}</span>
- </span>
- </code></div>
- </div>
- <p>获取连接资源描述符</p>
- <div class="detailHeader" id="hasRespond-detail">
- hasRespond()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public bool <b>hasRespond</b>()</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">{return}</td>
- <td class="paramTypeCol">bool</td>
- <td class="paramDescCol">如果有返回 true, 否则返回 false</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L330">sdk/php/lib/XSServer.class.php#L330</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">hasRespond</span><span style="color: #007700">()<br />{<br /> </span><span style="color: #FF8000">// check socket<br /> </span><span style="color: #007700">if (</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sock </span><span style="color: #007700">=== </span><span style="color: #0000BB">null </span><span style="color: #007700">|| </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_flag </span><span style="color: #007700">& (</span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">BROKEN </span><span style="color: #007700">| </span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">FILE</span><span style="color: #007700">))<br /> return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$wfds </span><span style="color: #007700">= </span><span style="color: #0000BB">$xfds </span><span style="color: #007700">= array();<br /> </span><span style="color: #0000BB">$rfds </span><span style="color: #007700">= array(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sock</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$res </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_select</span><span style="color: #007700">(</span><span style="color: #0000BB">$rfds</span><span style="color: #007700">, </span><span style="color: #0000BB">$wfds</span><span style="color: #007700">, </span><span style="color: #0000BB">$xfds</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">, </span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /> return </span><span style="color: #0000BB">$res </span><span style="color: #007700">> </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br />}</span>
- </span>
- </code></div>
- </div>
- <p>判断服务端是否有可读数据
- 用于某些特别情况在 <a href="XSServer.html#getRespond">getRespond</a> 前先调用和判断, 以免阻塞</p>
- <div class="detailHeader" id="open-detail">
- open()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public void <b>open</b>(mixed $conn)</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$conn</td>
- <td class="paramTypeCol">mixed</td>
- <td class="paramDescCol">服务端连接参数, 支持: <端口号|host:port|本地套接字路径></td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L161">sdk/php/lib/XSServer.class.php#L161</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">close</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_conn </span><span style="color: #007700">= </span><span style="color: #0000BB">$conn</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_flag </span><span style="color: #007700">= </span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">BROKEN</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_sendBuffer </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_project </span><span style="color: #007700">= </span><span style="color: #0000BB">null</span><span style="color: #007700">;<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">connect</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_flag </span><span style="color: #007700">^= </span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">BROKEN</span><span style="color: #007700">;<br /> if (</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">xs </span><span style="color: #007700">instanceof </span><span style="color: #0000BB">XS</span><span style="color: #007700">)<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">setProject</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">xs</span><span style="color: #007700">-></span><span style="color: #0000BB">getName</span><span style="color: #007700">());<br />}</span>
- </span>
- </code></div>
- </div>
- <p>打开服务端连接
- 如果已关联 XS 对象, 则会同时切换至相应的项目名称</p>
- <div class="detailHeader" id="reopen-detail">
- reopen()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public XSServer <b>reopen</b>(bool $force=false)</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$force</td>
- <td class="paramTypeCol">bool</td>
- <td class="paramDescCol">是否强制重新连接, 默认为否</td>
- </tr>
- <tr>
- <td class="paramNameCol">{return}</td>
- <td class="paramTypeCol">XSServer</td>
- <td class="paramDescCol">返回自己, 以便串接操作</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L180">sdk/php/lib/XSServer.class.php#L180</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">reopen</span><span style="color: #007700">(</span><span style="color: #0000BB">$force </span><span style="color: #007700">= </span><span style="color: #0000BB">false</span><span style="color: #007700">)<br />{<br /> if (</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_flag </span><span style="color: #007700">& </span><span style="color: #0000BB">self</span><span style="color: #007700">::</span><span style="color: #0000BB">BROKEN </span><span style="color: #007700">|| </span><span style="color: #0000BB">$force </span><span style="color: #007700">=== </span><span style="color: #0000BB">true</span><span style="color: #007700">)<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">open</span><span style="color: #007700">(</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_conn</span><span style="color: #007700">);<br /> return </span><span style="color: #0000BB">$this</span><span style="color: #007700">;<br />}</span>
- </span>
- </code></div>
- </div>
- <p>重新打开连接
- 仅应用于曾经成功打开的连并且异常关闭了</p>
- <div class="detailHeader" id="sendCommand-detail">
- sendCommand()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public void <b>sendCommand</b>(mixed $cmd)</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$cmd</td>
- <td class="paramTypeCol">mixed</td>
- <td class="paramDescCol">要提交的指令, 支持 XSCommand 实例或 cmd 构造函数的第一参数</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L302">sdk/php/lib/XSServer.class.php#L302</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">sendCommand</span><span style="color: #007700">(</span><span style="color: #0000BB">$cmd</span><span style="color: #007700">)<br />{<br /> if (!</span><span style="color: #0000BB">$cmd </span><span style="color: #007700">instanceof </span><span style="color: #0000BB">XSCommand</span><span style="color: #007700">)<br /> </span><span style="color: #0000BB">$cmd </span><span style="color: #007700">= new </span><span style="color: #0000BB">XSCommand</span><span style="color: #007700">(</span><span style="color: #0000BB">$cmd</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">write</span><span style="color: #007700">(</span><span style="color: #0000BB">strval</span><span style="color: #007700">(</span><span style="color: #0000BB">$cmd</span><span style="color: #007700">));<br />}</span>
- </span>
- </code></div>
- </div>
- <p>往服务器直接发送指令 (无缓存)</p>
- <div class="detailHeader" id="setProject-detail">
- setProject()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public void <b>setProject</b>(string $name, string $home='')</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$name</td>
- <td class="paramTypeCol">string</td>
- <td class="paramDescCol">项目名称</td>
- </tr>
- <tr>
- <td class="paramNameCol">$home</td>
- <td class="paramTypeCol">string</td>
- <td class="paramDescCol">项目在服务器上的目录路径, 可选参数(不得超过255字节).</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L234">sdk/php/lib/XSServer.class.php#L234</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">setProject</span><span style="color: #007700">(</span><span style="color: #0000BB">$name</span><span style="color: #007700">, </span><span style="color: #0000BB">$home </span><span style="color: #007700">= </span><span style="color: #DD0000">''</span><span style="color: #007700">)<br />{<br /> if (</span><span style="color: #0000BB">$name </span><span style="color: #007700">!== </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_project</span><span style="color: #007700">)<br /> {<br /> </span><span style="color: #0000BB">$cmd </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'cmd' </span><span style="color: #007700">=> </span><span style="color: #0000BB">CMD_USE</span><span style="color: #007700">, </span><span style="color: #DD0000">'buf' </span><span style="color: #007700">=> </span><span style="color: #0000BB">$name</span><span style="color: #007700">, </span><span style="color: #DD0000">'buf1' </span><span style="color: #007700">=> </span><span style="color: #0000BB">$home</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">execCommand</span><span style="color: #007700">(</span><span style="color: #0000BB">$cmd</span><span style="color: #007700">, </span><span style="color: #0000BB">CMD_OK_PROJECT</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">_project </span><span style="color: #007700">= </span><span style="color: #0000BB">$name</span><span style="color: #007700">;<br /> }<br />}</span>
- </span>
- </code></div>
- </div>
- <p>设置当前项目</p>
- <div class="detailHeader" id="setTimeout-detail">
- setTimeout()
- <span class="detailHeaderTag">
- 方法
- </span>
- </div>
- <table class="summaryTable">
- <tr><td colspan="3">
- <div class="signature2">
- public void <b>setTimeout</b>(int $sec)</div>
- </td></tr>
- <tr>
- <td class="paramNameCol">$sec</td>
- <td class="paramTypeCol">int</td>
- <td class="paramDescCol">秒数, 设为 0则永不超时直到客户端主动关闭</td>
- </tr>
- </table>
- <div class="sourceCode">
- <b>源码:</b> <a class="sourceLink" href="https://github.com/hightman/xunsearch/blob/master/sdk/php/lib/XSServer.class.php#L248">sdk/php/lib/XSServer.class.php#L248</a> (<b><a href="#" class="show">显示</a></b>)
- <div class="code"><code><span style="color: #000000">
- <span style="color: #0000BB"></span><span style="color: #007700">public function </span><span style="color: #0000BB">setTimeout</span><span style="color: #007700">(</span><span style="color: #0000BB">$sec</span><span style="color: #007700">)<br />{<br /> </span><span style="color: #0000BB">$cmd </span><span style="color: #007700">= array(</span><span style="color: #DD0000">'cmd' </span><span style="color: #007700">=> </span><span style="color: #0000BB">CMD_TIMEOUT</span><span style="color: #007700">, </span><span style="color: #DD0000">'arg' </span><span style="color: #007700">=> </span><span style="color: #0000BB">$sec</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">execCommand</span><span style="color: #007700">(</span><span style="color: #0000BB">$cmd</span><span style="color: #007700">, </span><span style="color: #0000BB">CMD_OK_TIMEOUT_SET</span><span style="color: #007700">);<br />}</span>
- </span>
- </code></div>
- </div>
- <p>设置服务端超时秒数</p>
- </div><!-- end of content -->
- <div id="apiFooter">
- Copyright © 2008-2011 by <a href="http://www.xunsearch.com" target="_blank">杭州云圣网络科技有限公司</a><br/>
- All Rights Reserved.<br/>
- </div><!-- end of footer -->
- <script type="text/javascript">
- /*<![CDATA[*/
- $("a.toggle").toggle(function(){
- $(this).text($(this).text().replace(/Hide/,'Show'));
- $(this).parents(".summary").find(".inherited").hide();
- },function(){
- $(this).text($(this).text().replace(/Show/,'Hide'));
- $(this).parents(".summary").find(".inherited").show();
- });
- $(".sourceCode a.show").toggle(function(){
- $(this).text($(this).text().replace(/show/,'hide'));
- $(this).parents(".sourceCode").find("div.code").show();
- },function(){
- $(this).text($(this).text().replace(/hide/,'show'));
- $(this).parents(".sourceCode").find("div.code").hide();
- });
- $("a.sourceLink").click(function(){
- $(this).attr('target','_blank');
- });
- /*]]>*/
- </script>
- </div><!-- end of page -->
- </body>
- </html>
|