archived-doc-es/reference/sam/reference.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 14af302c9c0e561fa6f9cdd956268758ba9a89c5 Maintainer: regiemix 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>

   <!-- FIXME: Upgrade to the new-oo-markup -->
   <!-- class definition section -->
   <section xml:id="sam.classes">
    &reftitle.classes;

<!-- Connection class  -->
    <section xml:id="class.samconnection">
     <title><classname>SAMConnection</classname></title>
     <para>
      Objeto que representa una conexión a un servidor de mensajería
     </para>

     <section>
      &reftitle.constructor;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="samconnection.construct">new SAMConnection</link> - construir un nuevo objeto de conexión que permite la conexión a una infrastructura de mensajería.
        </para>
       </listitem>
      </itemizedlist>
     </section>

     <section>
      &reftitle.methods;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="samconnection.commit">commit</link>
         - un método que hace el 'commit' (consolida) una unidad de trabajo
         volátil.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.connect">connect</link>
         - un método que conecta un script PHP a un servidor de mensajería.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.disconnect">disconnect</link>
         - un método que desconecta un script PHP de un servidor de mensajería.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.isconnected">isConnected</link>
         - un método que comprueba si un script PHP está conectado a un
          servidor de mensajería.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.peek">peek</link>
         - un método que recibe un mensaje de una cola de mensajes sin eliminarlo
          de la cola.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.peekall">peekAll</link>
         - un método que recibe uno o más mensajes de una cola de mensajes sin
         eliminarlos de la cola.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.receive">receive</link>
         - un método que recibe un mensaje de una cola de mensajes o suscripción.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.remove">remove</link>
         - un método que elimina un mensaje de una cola.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.rollback">rollback</link>
         - un método que cancela (revierte) una unidad de trabajo no consolidada.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.send">send</link>
         - un método que envía un mensaje a una cola o lo publica en un tema.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.setdebug">setDebug</link>
         - un método que activa o desactiva la información adicional de depuración.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.subscribe">subscribe</link>
         - un método que crea una suscripción a uno o más temas.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.unsubscribe">unsubscribe</link>
         - un método que destruye una suscripción a uno o más temas.
        </para>
       </listitem>
      </itemizedlist>
     </section>

     <section>
      &reftitle.properties;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="samconnection.errno">errno</link> - el código
         numérico de error del último error que se ha producido en esta
         conexión. Esta propiedad toma el valor 0 si la última operación acabó con
         éxito.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="samconnection.error">error</link> - el literal
         del último error encontrado en esta conexión.
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>   <!-- xml:id=class.samconnection -->

<!-- Message class    *************************************************** -->
    <section xml:id="class.sammessage">
     <title><classname>SAMMessage</classname></title>
     <para>
      Objeto que representa un mensaje a ser enviado o recibido
     </para>

     <section>
      &reftitle.constructor;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sammessage.construct">new SAMMessage</link> - construye un
         nuevo mensaje.
        </para>
       </listitem>
      </itemizedlist>
     </section>

     <section>
      &reftitle.properties;
      <itemizedlist>
       <listitem>
        <para>
         <link linkend="sammessage.body">body</link> - el cuerpo del
         mensaje.
        </para>
       </listitem>
       <listitem>
        <para>
         <link linkend="sammessage.header">header</link> - las propiedades de
         cabecera del mensaje.
        </para>
       </listitem>
      </itemizedlist>
     </section>
    </section>   <!-- xml:id=class.sammessage -->

   </section>    <!-- xml:id=sam.classes -->


  </partintro>

  <!-- This seems to create the table of contents -->
 &reference.sam.entities.SAMConnection;
 &reference.sam.entities.SAMMessage;

 </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:"~/.phpdoc/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
-->