SAMConnection::receive
(PECL sam >= 0.1.0)
SAMConnection::receive — Receive a message from a queue or subscription.
Описание
Список параметров
-
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.
Property name Possible values SAM_CORRELID Used to request selection of the message to receive based upon the correlation id string of the message. SAM_MESSAGEID Used to request selection of the message to receive based upon the message id string of the message. 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.
Возвращаемые значения
This method returns a SAMMessage object or FALSE if an error occurs.
Примеры
Пример #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";
}
?>
Пример #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));
?>
Пример #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) {
// The receive failed!
echo "Receive failed ($conn->errno) $conn->error";
}
?>
Please note that $subscriptionName is a subscription id returned from an earlier subscribe call.
- PHP Руководство
- Функции по категориям
- Индекс функций
- Справочник функций
- Другие службы
- Simple Asynchronous Messaging
- Функция SAMConnection::commit() - Commits (completes) the current unit of work.
- Функция SAMConnection::connect() - Establishes a connection to a Messaging Server
- Функция SAMConnection::__construct() - Creates a new connection to a Messaging Server
- Функция SAMConnection::disconnect() - Disconnects from a Messaging Server
- Функция SAMConnection::errno() - Contains the unique numeric error code of the last executed SAM operation.
- Функция SAMConnection::error() - Contains the text description of the last failed SAM operation.
- Функция SAMConnection::isConnected() - Queries whether a connection is established to a Messaging Server
- Функция SAMConnection::peek() - Read a message from a queue without removing it from the queue.
- Функция SAMConnection::peekAll() - Read one or more messages from a queue without removing it from the queue.
- Функция SAMConnection::receive() - Receive a message from a queue or subscription.
- Функция SAMConnection::remove() - Remove a message from a queue.
- Функция SAMConnection::rollback() - Cancels (rolls back) an in-flight unit of work.
- Функция SAMConnection::send() - Send a message to a queue or publish an item to a topic.
- Функция SAMConnection::setDebug() - Turn on or off additional debugging output.
- Функция SAMConnection::subscribe() - Create a subscription to a specified topic.
- Функция SAMConnection::unsubscribe() - Cancel a subscription to a specified topic.
- Функция SAMMessage::body() - The body of the message.
- Функция SAMMessage::__construct() - Creates a new Message object
- Функция SAMMessage::header() - The header properties of the message.
Коментарии
404 Not Found