STOMP_ACK(3) 1 STOMP_ACK(3)
Stomp::ack - Acknowledges consumption of a message
Object oriented style (method):
SYNOPSIS
public bool Stomp::ack (mixed $msg, [array $headers])
DESCRIPTION
Procedural style:
bool stomp_ack (resource $link, mixed $msg, [array $headers])
Acknowledges consumption of a message from a subscription using client acknowledgment.
PARAMETERS
o $link
-Procedural style only: The stomp link identifier returned by stomp_connect(3).
o $msg
- The message/messageId to be acknowledged.
o $headers
-Associative array containing the additional headers (example: receipt).
RETURN VALUES
Returns TRUE on success or FALSE on failure.
NOTES
Note
A transaction header may be specified, indicating that the message acknowledgment should be part of the named transaction.
Tip
Stomp is inherently asynchronous. Synchronous communication can be implemented adding a receipt header. This will cause methods to
not return anything until the server has acknowledged receipt of the message or until read timeout was reached.
EXAMPLES
Example #1
Object oriented style
<?php
$queue = '/queue/foo';
$msg = 'bar';
/* connection */
try {
$stomp = new Stomp('tcp://localhost:61613');
} catch(StompException $e) {
die('Connection failed: ' . $e->getMessage());
}
/* send a message to the queue 'foo' */
$stomp->send($queue, $msg);
/* subscribe to messages from the queue 'foo' */
$stomp->subscribe($queue);
/* read a frame */
$frame = $stomp->readFrame();
if ($frame->body === $msg) {
/* acknowledge that the frame was received */
$stomp->ack($frame);
}
/* remove the subscription */
$stomp->unsubscribe($queue);
/* close connection */
unset($stomp);
?>
Example #2
Procedural style
<?php
$queue = '/queue/foo';
$msg = 'bar';
/* connection */
$link = stomp_connect('ssl://localhost:61612');
/* check connection */
if (!$link) {
die('Connection failed: ' . stomp_connect_error());
}
/* begin a transaction */
stomp_begin($link, 't1');
/* send a message to the queue 'foo' */
stomp_send($link, $queue, $msg, array('transaction' => 't1'));
/* commit a transaction */
stomp_commit($link, 't1');
/* subscribe to messages from the queue 'foo' */
stomp_subscribe($link, $queue);
/* read a frame */
$frame = stomp_read_frame($link);
if ($frame['body'] === $msg) {
/* acknowledge that the frame was received */
stomp_ack($link, $frame['headers']['message-id']);
}
/* remove the subscription */
stomp_unsubscribe($link, $queue);
/* close connection */
stomp_close($link);
?>
PHP Documentation Group STOMP_ACK(3)