SAMConnection::peek()

(no version information, might be only in CVS)

SAMConnection::peek() --  Read a message from a queue without removing it from the queue.

Description

class SAMConnection {

SAMMessage peek ( string target [, array properties] )

}

Warning: This method is not currently implemented.

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 namePossible values
SAM_SELECTString selector used to select messages from the queue. Typically this the correlation id string returned by a "send" request.

Return Values

This method returns a SAMMessage object or FALSE if an error occurs.

Examples

Example 1. Retrieve the next message from a queue without removing it

<?php
$msg
= $conn->peek('queue://receive/test');

if (!
$msg) {
  
// The peek failed!
  
echo "Peek failed ($conn->errno) $conn->error";
}
?>

Example 2. Retrieve a specific message from a queue without removing it from the queue

<?php

$msg
= $conn->peek('queue://receive/test', array(SAM_SELECT => $token));

?>