SAMConnection::peek
Read a message from a queue without removing it from the queue
&reftitle.description;
SAMMessageSAMConnection::peek
stringtarget
arrayproperties
&reftitle.parameters;
target
The identity of the queue from which to peek the message.
properties
An optional associative array of properties describing other
parameters to control the peek operation.
Property name
Possible values
SAM_CORRELID
This is the target correlation id string of the message. This
would typically have been returned by a "send" request.
SAM_MESSAGEID
This is the message id string of the message which is to be
peeked.
&reftitle.returnvalues;
This method returns a SAMMessage object or &false; if an error occurs.
&reftitle.examples;
Retrieve the next message from a queue without removing it
peek('queue://receive/test');
if (!$msg) {
// The peek failed!
echo "Peek failed ($conn->errno) $conn->error";
}
?>
]]>
Retrieve a specific message from a queue without removing it from the queue
peek('queue://receive/test', array(SAM_MESSAGEID => $messageId));
?>
]]>
&reftitle.seealso;