Stomp::abort
stomp_abort
(PECL stomp >= 0.1.0)
Stomp::abort -- stomp_abort — Rolls back a transaction in progress
Description
Object oriented style (method):
public Stomp::abort ( string $transaction_id [, array $headers ] ) : bool
Procedural style:
stomp_abort ( resource $link , string $transaction_id [, array $headers ] ) : bool
Rolls back a transaction in progress.
Parameters
-
link -
Procedural style only: The stomp link identifier returned by stomp_connect().
-
transaction_id -
The transaction to abort.
-
headers -
Associative array containing the additional headers (example: receipt).
Return Values
Returns true on success or false on failure.
Notes
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
/* connection */
try {
$stomp = new Stomp('tcp://localhost:61613');
} catch(StompException $e) {
die('Connection failed: ' . $e->getMessage());
}
/* begin a transaction */
$stomp->begin('t1');
/* send a message to the queue */
$stomp->send('/queue/foo', 'bar', array('transaction' => 't1'));
/* rollback */
$stomp->abort('t1');
/* close connection */
unset($stomp);
?> Example #2 Procedural style
<?php
/* connection */
$link = stomp_connect('tcp://localhost:61613');
/* 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/foo', 'bar', array('transaction' => 't1'));
/* rollback */
stomp_abort($link, 't1');
/* close connection */
stomp_close($link);
?>
© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/stomp.abort.php