SAMConnection->connect()

Liste de paramètres

protocol

Une chaîne structurée identifiant le protocole à utiliser lors de la connexion à une serveur de messagerie. Les protocoles supportés sont représentés par des constantes qui sont utilisées normalement, mais, si demandé, la chaîne peut être composée dynamiquement dans le script. La chaîne est composée de deux parties : la première est l'identifiant du protocole et la seconde, les options du protocole. Les deux parties sont séparées par deux points (:). Les valeurs acceptables sont décrites dans le tableau suivante :

Protocole	Constanet	Utilisation
mqtt	SAM_MQTT	Utilisation du protocole MQTT (MQ Telemetry Transport) pour la connexion d'un client à un serveur.
wmq	SAM_WMQ	Utilisation du protocole IBM MQSeries pour la connexion d'un client à un serveur de messagerie distant. C'est l'équivalent de "wmq:client" (SAM_WMQ_CLIENT). De plus, un nom de broker (SAM_BROKER) doit être spécifié dans le tableau des options.
wmq:client	SAM_WMQ_CLIENT	Utilisation du protocole IBM MQSeries pour la connexion d'un client à un serveur de messagerie distant. De plus, un nom de broker (SAM_BROKER) doit être spécifié dans le tableau des options.
wmq:bindings	SAM_WMQ_BINDINGS	Utilisation du protocole IBM MQSeries pour la connexion à un serveur de messagerie local et une communication via la mémoire partagée. De plus, un nom de broker (SAM_BROKER) doit être spécifié dans le tableau des options.
wpm	SAM_WPM	Utilisation du protocole IBM WebSphere Platform Messaging pour la connexion à une infrastructure de messagerie WebSphere Application. Un nom de bus doit être spécifié dans le tableau des options (SAM_BUS) ainsi qu'une cible.
rtt	SAM_RTT	Utilisation du protocole de transport IBM Realtime pour la connexion à une infrastructure de messagerie.

properties

Un tableau associatif optionnel de propriétés décrivant les détails de la connexion. Le tableau suivant liste les noms des propriétés disponibles et des valeurs acceptées :

Nom de la propriété	Valeur par défaut	Utilisation
SAM_BROKER	aucune	Le nom du broker ou du gestionnaire de file d'attente fonctionnant sur le serveur de messagerie. Cette propriété doit être définie si vous utilisez un des protocoles WebSphere MQSeries (SAM_WMQ, SAM_WMQ_CLIENT, SAM_WMQ_BINDINGS).
SAM_HOST	localhost	Le nom de l'hôte de la machine sur laquelle le serveur de messagerie fonctionne.
SAM_PORT	1414 pour SAM_WMQ, 1506 pour SAM_WPM, ou 1883 pour SAM_MQTT	Le numéro du port utilisé pour la communication avec le serveur de messagerie.
SAM_EXPIRE_AFTER	0	Durée, en millisecondes, après laquelle un message est sensé expirer et peut être effacé depuis les files d'attente. Par défaut, la valeur est 0, indiquant que le message n'expire jamais. Attention : Pas encore implémenté !
SAM_MESSAGE_PERSISTENCE	aucune	Spécifie si les messages doivent être persistents durant la délivrance. La valeur peut être SAM_PERSISTENT ou SAM_NON_PERSISTENT. La valeur par défaut est dépendant du type de connexion ainsi que des capacités du serveur de messagerie sur lequel la connexion est effectuée. Attention : Pas encore implémenté !
SAM_MQTT_CLEANSTART	FALSE	Option de connexion optionnel pour indiquer à un serveur MQTT que toutes les connexions précédentes pour ce client doivent être effacées et que les souscriptions doivent être effacées lorsque le client se déconnecte explicitement ou de façon inattendu. Le fait de définir la valeur à TRUE fait que SAM refusera toute souscription déjà en place pour le client lorsqu'il se connecte ainsi que les souscriptions lorsque le client se déconnecte. Le fait de définir cette valeur à FALSE ou d'utiliser la valeur par défaut, va permettre d'autoriser toutes les souscriptions de façon durant et ce, même si le client se déconnecte.
SAM_PASSWORD	aucune	Le mot de passe à utiliser lors de l'identification avec le serveur de messagerie.
SAM_TRANSACTIONS	SAM_AUTO	Indique comment les transactions sont gérées sur la connexion. La vaeur peut être SAM_AUTO (la valeur par défaut) permettant une gestion automatique des opérations ou SAM_MANUEL permettant au script PHP de contrôler les transactions. Si SAM_MANUEL est utilisé, toutes les transactions seront annulées si le script se termine ou si la connexion se ferme sans qu'une validation sont effectuée.
SAM_USERID	aucune	L'identifiant de l'utilisation à utiliser lors de l'identification avec le serveur de messagerie.
SAM_WPM_DUR_SUB_HOME	aucune	Le nom du moteur de messagerie où les souscriptions durables sont gérées. (uniquement WPM).