Stomp::ack

stomp_ack

(PECL stomp >= 0.1.0)

Stomp::ack -- stomp_ack — Valide la rĂ©ception d'un message

Description

Style orienté objet (méthode) :

public function Stomp::ack(mixed $msg, array $headers = ?): bool

Style procédural :

function stomp_ack(resource $link, mixed $msg, array $headers = ?): bool

Valide la réception d'un message par une souscription.

Liste de paramĂštres

link
Style procédural uniquement : L'identifiant stomp retourné par la fonctionstomp_connect().
msg
Le message ou l'identifiant du message Ă  valider.
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

$queue = '/queue/foo';
$msg = 'bar';

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

/* envoi d'un message Ă  la file 'foo' */
$stomp->send($queue, $msg);

/* souscription aux messages de la file 'foo' */
$stomp->subscribe($queue);

/* lecture d'un message */
$frame = $stomp->readFrame();

if ($frame->body === $msg) {
/* confirmation de la réception du message */
$stomp->ack($frame);
}

/* supprime la souscription Ă  la file 'foo' */
$stomp->unsubscribe($queue);

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

?>

Exemple #2 Style procédural

<?php

$queue = '/queue/foo';
$msg = 'bar';

/* connexion */
$link = stomp_connect('ssl://localhost:61612');

/* 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, $msg, array('transaction' => 't1'));

/* validation de la transaction */
stomp_commit($link, 't1');

/* souscription aux messages de la file 'foo' */
stomp_subscribe($link, $queue);

/* lecture d'un message */
$frame = stomp_read_frame($link);

if ($frame['body'] === $msg) {
/* confirmation de la réception du message */
stomp_ack($link, $frame['headers']['message-id']);
}

/* supprime la souscription Ă  la file 'foo' */
stomp_unsubscribe($link, $queue);

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

?>

Notes

Note: Un en-tĂȘte de transaction peut ĂȘtre spĂ©cifiĂ©, indiquant que la confirmation des messages doit faire partie de la transaction.

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.

Found A Problem?

Learn How To Improve This Page ‱ Submit a Pull Request ‱ Report a Bug
add a note

User Contributed Notes

There are no user contributed notes for this page.