Manuel PHP
Précédent |  | Suivant

# SAMConnection::connect()

(no version information, might be only in CVS)

SAMConnection::connect() -- Établie une connexion à un serveur de messagerie

## Description

L'appel à la méthode "connect" sur un objet SAMConnection connecte le script PHP à un serveur de messagerie. Aucun message ne peut être envoyé ou reçu tant qu'une connexion n'est pas établie.

class SAMConnection {
bool connect ( string protocol [, array properties] )
}

## 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
  --- | --- | ---
  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 ou 1506 pour SAM_WPM | Le numéro du port utilisé pour la communication avec le serveur de messagerie.
  SAM_CLIENT_ID | aucune | Une chaîne utilisée pour identifier de façon unique le client lors de l'accès aux souscriptions. Attention : Pas encore implémenté !
  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_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).

## Valeurs de retour

Cette méthode retourne `FALSE` si une erreur survient.

## Exemples

Exemple 1. Création d'une connexion à un serveur de messagerie en utilisant le protocole IBM MQSeries (WMQ)

`<?php $conn->connect(SAM_WMQ, array(SAM_HOST => 'Myhost.myco.com', SAM_PORT => 1506, SAM_BROKER => 'MyBroker')); ?>`

Exemple 2. Création d'une connexion avec contrôle des transactions, hôte par défaut et valeur du port de communication

`<?php $conn->connect(SAM_WMQ, array(SAM_BROKER => 'MyBroker', SAM_TRANSACTIONS => SAM_MANUAL)); ?>`

Exemple 3. Création d'une connexion à un serveur de messagerie en utilisant le protocole IBM WebSphere Platform Messaging (WPM)

`<?php $conn->connect(SAM_WPM, array(SAM_ENDPOINTS => 'localhost:7278:BootstrapBasicMessaging', SAM_BUS => 'Bus1', SAM_TARGETCHAIN => 'InboundBasicMessaging')); ?>`

Précédent | Sommaire | Suivant
SAMConnection::commit() | Niveau supérieur | SAMConnection::SAMConnection()