Manuale PHP
IndietroAvanti


SAMConnection::peek()

(no version information, might be only in CVS)

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

Descrizione

class SAMConnection {

SAMMessage peek ( string target [, array properties] )

}

Elenco dei parametri

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_CORRELIDThis is the target correlation id string of the message. This would typically have been returned by a "send" request.
SAM_MESSAGEIDThis is the message id string of the message which is to be peeked.

Valori restituiti

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

Esempi

Esempio 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";
}
?>

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

<?php

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

?>



IndietroPartenzaAvanti
SAMConnection::isConnected()RisaliSAMConnection::peekAll()