function.samconnection-peek.html

来自「php的帮助文档,涉及到PHP的案例和基本语法,以及实际应用内容」· HTML 代码 · 共 160 行

HTML
160
字号
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head>  <title>Read a message from a queue without removing it from the queue.</title>  <meta http-equiv="content-type" content="text/html; charset=UTF-8"> </head> <body><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.samconnection-isconnected.html">SAMConnection->isConnected</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.samconnection-peekall.html">SAMConnection->peekAll</a></div> <div class="up"><a href="ref.sam.html">SAM Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div><hr /><div id="function.samconnection-peek" class="refentry"> <div class="refnamediv">  <h1 class="refname">SAMConnection-&gt;peek</h1>  <p class="verinfo">(No version information available, might be only in CVS)</p><p class="refpurpose"><span class="refname">SAMConnection-&gt;peek</span> &mdash; <span class="dc-title">   Read a message from a queue without removing it from the queue.  </span></p> </div> <div class="refsect1 description">  <h3 class="title">Description</h3>  <div class="classsynopsis">   <div class="ooclass"><b class="classname">SAMConnection</b></div>   <div class="methodsynopsis dc-description">    <span class="type">SAMMessage</span> <span class="methodname"><b><b>peek</b></b></span>     ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$target</tt></span>    [, <span class="methodparam"><span class="type">array</span> <tt class="parameter">$properties</tt></span>   ] )</div>  </div> </div> <div class="refsect1 parameters">  <h3 class="title">Parameters</h3>  <p class="para">   <dl>    <dt>     <span class="term"><i><tt class="parameter">target</tt></i></span>     <dd>      <p class="para">       The identity of the queue from which to peek the message.      </p>     </dd>    </dt>    <dt>     <span class="term"><i><tt class="parameter">properties</tt></i></span>     <dd>      <p class="para">       An optional associative array of properties describing other       parameters to control the peek operation.       <table class="informaltable">        <colgroup>         <thead valign="middle">          <tr valign="middle">           <th colspan="1">Property name</th>           <th colspan="1">Possible values</th>          </tr>         </thead>         <tbody valign="middle" class="tbody">          <tr valign="middle">           <td colspan="1" rowspan="1" align="left">SAM_CORRELID</td>           <td colspan="1" rowspan="1" align="left">            This is the target correlation id string of the message. This            would typically have been returned by a &quot;send&quot; request.           </td>          </tr>          <tr valign="middle">           <td colspan="1" rowspan="1" align="left">SAM_MESSAGEID</td>           <td colspan="1" rowspan="1" align="left">            This is the message id string of the message which is to be            peeked.           </td>          </tr>                      </tbody>        </colgroup>       </table>      </p>     </dd>    </dt>   </dl>  </p> </div> <div class="refsect1 returnvalues">  <h3 class="title">Return Values</h3>  <p class="para">   This method returns a SAMMessage object or <b><tt>FALSE</tt></b> if an error occurs.  </p> </div> <div class="refsect1 examples">  <h3 class="title">Examples</h3>  <p class="para">   <div class="example">    <p><b>Example #1 Retrieve the next message from a queue without removing it</b></p>    <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$msg&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$conn</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">peek</span><span style="color: #007700">(</span><span style="color: #DD0000">'queue://receive/test'</span><span style="color: #007700">);<br /><br />if&nbsp;(!</span><span style="color: #0000BB">$msg</span><span style="color: #007700">)&nbsp;{<br />&nbsp;&nbsp;</span><span style="color: #FF8000">//&nbsp;The&nbsp;peek&nbsp;failed!<br />&nbsp;&nbsp;</span><span style="color: #007700">echo&nbsp;</span><span style="color: #DD0000">"Peek&nbsp;failed&nbsp;($conn-&gt;errno)&nbsp;$conn-&gt;error"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>    </div>   </div>  </p>  <p class="para">   <div class="example">    <p><b>Example #2 Retrieve a specific message from a queue without removing it from the queue</b></p>    <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br />$msg&nbsp;</span><span style="color: #007700">=&nbsp;</span><span style="color: #0000BB">$conn</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">peek</span><span style="color: #007700">(</span><span style="color: #DD0000">'queue://receive/test'</span><span style="color: #007700">,&nbsp;array(</span><span style="color: #0000BB">SAM_MESSAGEID&nbsp;</span><span style="color: #007700">=&gt;&nbsp;</span><span style="color: #0000BB">$messageId</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>    </div>   </div>  </p> </div> <div class="refsect1 seealso">  <h3 class="title">See Also</h3>  <p class="para">   <ul class="simplelist">    <li class="member"><a href="function.samconnection-peekall.html" class="xref">SAMConnection->peekAll</a></li>   </ul>  </p> </div></div><hr /><div style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.samconnection-isconnected.html">SAMConnection->isConnected</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.samconnection-peekall.html">SAMConnection->peekAll</a></div> <div class="up"><a href="ref.sam.html">SAM Functions</a></div> <div class="home"><a href="index.html">PHP Manual</a></div></div></body></html>

⌨️ 快捷键说明

复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?