SAMConnection::peek
(PECL sam >= 0.1.0)
SAMConnection::peek — Read a message from a queue without removing it from the queue.
Description
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 name Possible values SAM_CORRELID This is the target correlation id string of the message. This would typically have been returned by a "send" request. SAM_MESSAGEID This is the message id string of the message which is to be peeked.
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_MESSAGEID => $messageId));
?>
- 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