doc-fr/reference/sam/reference.xml

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.11 $ -->
<!-- EN-Revision: 1.11 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->

 <reference xml:id="ref.sam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <title>&Functions; SAM</title>

  <partintro>

   <section xml:id='sam.classes'>
    &reftitle.classes;

    <section xml:id='sam.class.Connection'>
     <title><classname>SAMConnection</classname></title>
     <para>
      Objet représentant une connexion à un serveur de messagerie
     </para>

     <section xml:id='sam.class.Connection.constructor'>
      &reftitle.constructor;
      <itemizedlist>
       <listitem>
        <para>
        <link linkend='function.samconnection-constructor'>new SAMConnection</link> : construit un nouvel objet de connexion permettant une
        connexion à une infrastructure de messagerie.
       </para>
      </listitem>
     </itemizedlist>
    </section>

    <section xml:id='sam.class.Connection.methods'>
     &reftitle.methods;
     <itemizedlist>
      <listitem>
       <para>
        <link linkend='function.samconnection-commit'>commit</link>
        : une méthode qui valide un travail.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-connect'>connect</link>
        : une méthode qui connecte un script PHP à un serveur de messagerie.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-disconnect'>disconnect</link>
        : une méthode qui déconnecte un script PHP d'un serveur de messagerie.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-isconnected'>isConnected</link>
        : une méthode qui vérifie si un script PHP est connecté à un serveur de messagerie.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-peek'>peek</link>
        : une méthode qui reçoit un message depuis la file d'attente sans pour autant l'effacer de la file d'attente.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-peekall'>peekAll</link>
        : une méthode qui reçoit un ou plusieurs messages depuis la file d'attente sans pour autant les effacer de la file d'attente.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-receive'>receive</link>
        : une méthode qui reçoit un message depuis la file d'attente ou depuis une souscription.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-remove'>remove</link>
        : une méthode qui efface un message depuis la file d'attente.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-rollback'>rollback</link>
        : une méthode qui annule un travail.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-send'>send</link>
        : une méthode qui envoie un message à une file d'attente ou sur un sujet.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-setDebug'>setDebug</link>
        : une méthode qui active ou non l'affichage des informations de déboguage
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-subscribe'>subscribe</link>
        : une méthode qui crée une souscription à un ou plusieurs sujets.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-unsubscribe'>unsubscribe</link>
        : une méthode qui détruit une suscription à un ou plusieurs sujets.
       </para>
      </listitem>
     </itemizedlist>
    </section>

    <section xml:id='sam.class.Connection.properties'>
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para>
        <link linkend='function.samconnection-errno'>errno</link> : le numéro de la dernière
        erreur survenue sur la connexion. Cette propriété est définie à 0 si la dernière opération
        a réussi.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.samconnection-error'>error</link> : la description
        de la dernière erreur survenue sur la connexion.
       </para>
      </listitem>
     </itemizedlist>
    </section>
   </section>

   <section xml:id='sam.class.Message'>
    <title><classname>SAMMessage</classname></title>
    <para>
     Objet représentant un message à envoyer ou à recevoir.
    </para>

    <section xml:id='sam.class.Message.constructor'>
     &reftitle.constructor;
     <itemizedlist>
      <listitem>
       <para>
        <link linkend='function.sammessage-constructor'>new SAMMessage</link> : construit un
        nouveau message.
       </para>
      </listitem>
     </itemizedlist>
    </section>

    <section xml:id='sam.class.Message.properties'>
     &reftitle.properties;
     <itemizedlist>
      <listitem>
       <para>
        <link linkend='function.sammessage-body'>body</link> : le corps du message.
       </para>
      </listitem>
      <listitem>
       <para>
        <link linkend='function.sammessage-header'>header</link> : les propriétés d'en-tête du message.
       </para>
      </listitem>
     </itemizedlist>
    </section>
   </section>

  </section>

 </partintro>

 &reference.sam.entities.functions;

</reference>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->