Stomp::abort

stomp_abort

(PECL stomp >= 0.1.0)

Stomp::abort -- stomp_abortAnnule une transaction en cours

Description

Style orienté objet (méthode) :

public Stomp::abort(string $transaction_id, array $headers = ?): bool

Style procédural :

stomp_abort(resource $link, string $transaction_id, array $headers = ?): bool

Annule une transaction en cours.

Liste de paramètres

link

Style procédural uniquement : L'identifiant stomp retourné par la fonctionstomp_connect().

transaction_id

ID de la transaction à annuler.

headers

Tableau associatif contenant les en-têtes additionnels (exemple : receipt).

Valeurs de retour

Cette fonction retourne true en cas de succès ou false si une erreur survient.

Exemples

Exemple #1 Style orienté objet

<?php

/* connexion */
try {
$stomp = new Stomp('tcp://localhost:61613');
} catch(
StompException $e) {
die(
'Connection failed: ' . $e->getMessage());
}

/* début de la transaction */
$stomp->begin('t1');

/* envoi d'un message à la file 'foo' */
$stomp->send('/queue/foo', 'bar', array('transaction' => 't1'));

/* annulation de la transaction */
$stomp->abort('t1');

/* fermeture de la connexion */
unset($stomp);
?>

Exemple #2 Style procédural

<?php

/* connexion */
$link = stomp_connect('tcp://localhost:61613');

/* vérification de la connexion */
if (!$link) {
die(
'Connection failed: ' . stomp_connect_error());
}

/* début de la transaction */
stomp_begin($link, 't1');

/* envoi d'un message à la file 'foo' */
stomp_send($link, '/queue/foo', 'bar', array('transaction' => 't1'));

/* annulation de la transaction */
stomp_abort($link, 't1');

/* fermeture de la connexion */
stomp_close($link);

?>

Notes

Astuce

Stomp est, par nature, asynchrone. Une communication synchrone peut être implémentée en ajoutant un en-tête receipt. Ceci fera que les méthodes ne retourneront rien tant que le message de confirmation n'aura pas été reçu ou tant que le délai d'attente ne sera pas atteint.