📄 function.samconnection-peekall.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html> <head> <title>Read one or more messages 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-peek.html">SAMConnection->peek</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.samconnection-receive.html">SAMConnection->receive</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-peekall" class="refentry"> <div class="refnamediv"> <h1 class="refname">SAMConnection->peekAll</h1> <p class="verinfo">(No version information available, might be only in CVS)</p><p class="refpurpose"><span class="refname">SAMConnection->peekAll</span> — <span class="dc-title"> Read one or more messages 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">array</span> <span class="methodname"><b><b>peekAll</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 messages should be peeked. </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 messages to be peeked. This would typically have been returned by a "send" 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 a 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 an array of SAMMessage objects 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 all messages in a queue without removing them</b></p> <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br />$msgArray </span><span style="color: #007700">= </span><span style="color: #0000BB">$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">peekAll</span><span style="color: #007700">(</span><span style="color: #DD0000">'queue://receive/test'</span><span style="color: #007700">);<br />if (</span><span style="color: #0000BB">$msgArray</span><span style="color: #007700">) {<br /> foreach ( </span><span style="color: #0000BB">$msgArray </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$msg</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Message $key: body = $msg->body\n"</span><span style="color: #007700">;<br /> }<br />} else {<br /> echo </span><span style="color: #DD0000">"PeekAll failed ($conn->errno) $conn->error"</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span></span></code></div> </div> </div> </p> <p class="para"> <div class="example"> <p><b>Example #2 Retrieve all messages from a queue with a matching correlation id </b></p> <div class="example-contents"><div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB"><?php<br /><br /> $msgArray </span><span style="color: #007700">= </span><span style="color: #0000BB">$conn</span><span style="color: #007700">-></span><span style="color: #0000BB">peekAll</span><span style="color: #007700">(</span><span style="color: #DD0000">'queue://receive/test'</span><span style="color: #007700">, array(</span><span style="color: #0000BB">SAM_CORRELID </span><span style="color: #007700">=> </span><span style="color: #0000BB">$correlId </span><span style="color: #007700">));<br /> if (</span><span style="color: #0000BB">$msgArray</span><span style="color: #007700">) {<br /><br /> foreach ( </span><span style="color: #0000BB">$msgArray </span><span style="color: #007700">as </span><span style="color: #0000BB">$key </span><span style="color: #007700">=> </span><span style="color: #0000BB">$msg</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"Message $key: body = $msg->body\n"</span><span style="color: #007700">;<br /> }<br /> }<br /> else<br /> echo </span><span style="color: #DD0000">"PeekAll failed ($conn->errno) $conn->error"</span><span style="color: #007700">;<br /> }<br /><br /></span><span style="color: #0000BB">?></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-peek.html" class="xref">SAMConnection->peek</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-peek.html">SAMConnection->peek</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.samconnection-receive.html">SAMConnection->receive</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 + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -