SAMConnection::receive()

(no version information, might be only in CVS)

SAMConnection::receive() --  Receive a message from a queue or subscription.

Description

class SAMConnection {

SAMMessage receive ( string target [, array properties] )

}

Parameters

target

The identity of the queue from which to receive the message.

properties

An optional associative array of properties describing other parameters to control the receive operation.

Property namePossible values
SAM_SELECT String selector used to select messages from the queue. Typically this the correlation id string returned by a "send" request.
SAM_WAIT Timeout value in milliseconds to control how long the request should block waiting to receive a message before returning with a failure if no message is available on the queue or topic. The default value is 0 meaning wait indefinitely and should be used with caution as the request may wait until the overall PHP script processing time limit has expired if no message becomes available.

Return Values

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

Examples

Example 1. Receiving a message from a queue

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

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

Example 2. Receiving a message from a queue with options

In this example the SAM_SELECT option is used to specify a selector string to be used to identify the message to receive and also a wait timeout of 10 seconds is specified.

<?php

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

?>