SAMConnection::send
(PECL sam >= 0.1.0)
SAMConnection::send — Envoie un message à une file d'attente ou le publie sur un sujet
Description
La méthode "send" est utilisée pour envoyer un message à une file d'attente spécifique ou le publier à un sujet spécifique. La méthode retourne l'identifiant de corrélation qui peut être utilisé comme sélecteur pour identifier les messages réponses.
Liste de paramètres
-
target -
Si l'on envoie un message, ce sera l'identité de la file d'attente (queue://queuename) ou, si on le publie à un sujet spécifique, l'identité du sujet (topic://topicname) auquel le message doit être délivré.
-
msg -
Le message à envoyer ou à publier.
-
properties -
Un tableau associatif optionnel de propriétés décrivant les autres paramètres pour contrôler l'opération.
Nom de la propriété Valeurs de la propriété SAM_DELIVERYMODE Indique si le serveur de messagerie doit s'assurer de la délivrance du message ou s'il accepte que les messages soient perdus en cas de défaillance du serveur de messagerie. La valeur de cette propriété peut être définie soit à SAM_PERSISTENT, pour indiquer que la perte des messages n'est pas acceptable, soit àSAM_NON_PERSISTENTsi la perte de messages est acceptable. Le comportement résultant de l'envoi dépendra des capacités du serveur de messagerie auquel est connecté le script PHP. Si le serveur ne supporte pas les messages persistants et queSAM_PERSISTENTest spécifié, l'envoi échouera avec une erreur indiquant que la fonctionnalité n'est pas disponible.SAM_PRIORITY Une valeur numérique entre 0 et 9 indique la priorité de délivrance du message. Une valeur de priorité de 0 indique une priorité basse, alors que 9 indique une priorité haute. Si aucune priorité n'est spécifiée, une valeur par défaut sera passée, dépendant du serveur de messagerie utilisé. SAM_CORRELID Une chaîne à assigner comme identifiant de corrélation pour ce message. Si aucune valeur n'est fournie, le serveur de messagerie peut assigner une valeur automatiquement. SAM_TIMETOLIVE Une durée, en millisecondes, indiquant combien de temps le serveur de messagerie doit retenir le message dans une file d'attente avant de le jeter. La valeur par défaut est 0 indiquant que le message doit être retenu indéfiniment. SAM_WMQ_TARGET_CLIENT Cette propriété n'est valide que lors de l'utilisation de WebSphere MQ et indique si l'on doit inclure un en-tête RFH2 dans le message. Cette option doit être définie à 'jms' ou 'mq'. Par défaut, elle vaut 'jms' ce qui signifie que l'en-tête RFH2 est incluse. Si la valeur 'mq' est spécifiée, alors, aucun en-tête RFH2 ne sera inclus dans le message.
Valeurs de retour
Un identifiant de corrélation qui peut être utilisé dans un appel de
réception en tant que sélecteur pour obtenir toutes les réponses, ou
FALSE si une erreur survient.
Note:
Note : un identifiant de corrélation ne sera retourné qu'en cas d'un envoi réussi à une file d'attente (queue://xxxx) et dans ce cas, sera l'identité du message sur la file d'attente. Si l'envoi est destiné à publier des données, la valeur retournée sera
TRUE, car aucun identifiant de corrélation ne sera disponible.
Exemples
Exemple #1 Envoi d'un message à une file d'attente
<?php
$msg = new SAMMessage('Ceci est un message simple');
$correlId = $conn->send('queue://send/test', $msg);
if (!$correlId) {
// L'envoi a échoué !
echo "L'envoi a échoué : ($conn->errno) $conn->error";
}
?>
Exemple #2 Publication d'un message sur un sujet
<?php
$msg = new SAMMessage('Ceci est un élément simple');
if (!$conn->send('topic://test', $msg)) {
// L'envoi a échoué !
echo "L'envoi a échoué : ($conn->errno) $conn->error";
}
?>Exemple #3 Envoi une demande et réceptionne la réponse
<?php
$msg = new SAMMessage('Ceci est un message simple');
$msg->header->SAM_REPLY_TO = 'queue://receive/test';
$correlid = $conn->send('queue://send/test', $msg);
if (!$correlid) {
// L'envoi a échoué !
echo "L'envoi a échoué : ($conn->errno) $conn->error";
} else {
$resp = $conn->receive('queue://receive/test', array(SAM_CORRELID => $correlid));
}
?>