SAMConnection->receive()
(No version information available, might be only in CVS)
SAMConnection->receive() —
Receive a message from a queue or subscription.
Description
SAMConnection
SAMMessage receive
( string $target
[, array $properties
] )
Parameters
-
target
-
The identity of the queue, topic or subscription from which to receive
the message.
-
properties
-
An optional associative array of properties describing other
parameters to control the receive operation.
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) {
echo "Receive failed ($conn->errno) $conn->error";
}
?>
Example #2 Receiving a message from a queue with options
In this example the SAM_CORRELID option is used to specify a correlation
id string to be used to identify the message to receive. A wait timeout
of 10 seconds is also specified.
<?php
$msg = $conn->receive('queue://receive/test', array(SAM_CORRELID => $token, SAM_WAIT => 10000));
?>
Example #3 Receiving a message from a subscription
In this example we show how to receive a message from a subscription id.
<?php
$msg = $conn->receive($subscriptionName);
if (!$msg) {
echo "Receive failed ($conn->errno) $conn->error";
}
?>
Please note that $subscriptionName is a subscription id returned from an
earlier subscribe call.
SAMConnection->peekAll()
