yaz-connect.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: regiemix Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="function.yaz-connect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>yaz_connect</refname>
  <refpurpose>
   Prepara una conexión a un servidor Z39.50
  </refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>yaz_connect</methodname>
   <methodparam><type>string</type><parameter>zurl</parameter></methodparam>
   <methodparam choice="opt"><type>mixed</type><parameter>options</parameter></methodparam>
  </methodsynopsis>
  <para>
   Esta función devuelve un recurso de conexión en caso de éxito, cero en caso
   de fallo.
  </para>
  <para>
   <function>yaz_connect</function> prepara una conexión a un servidor 
   Z39.50 . 
   Esta función es no bloqueante y no intenta establecer 
   una conexión - únicamente prepara la conexión para que pueda ser realizada posteriormente cuando 
   se llame a la función <function>yaz_wait</function>.
  </para>
  <note>
   <para>
    El proxy <link xlink:href="&url.yaz-proxy;">YAZ </link> es un proxy 
    Z39.50 disponible gratuitamente.
   </para>
  </note>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>zurl</parameter></term>
     <listitem>
      <para>
       Un string que toma la forma <literal>host[:port][/database]</literal>.
       Si se omite el port, se utilizará el port 210. Si se omite database
       se utilizará <literal>Default</literal> .
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Si se trata de un string, éste se trata como el string de autenticación Z39.50 V2  
       (OpenAuth).
      </para>
      <para>
       Si se trata de un array, el contenido del array sirve como opciones.
       <variablelist>
        <varlistentry>
         <term>user</term>
         <listitem>
          <para>
           Nombre de usuario para la autenticación.
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>group</term>
         <listitem>
          <para>
           Grupo para la autenticación.
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>password</term>
          <listitem>
           <para>
            Contraseña para la autenticación.
           </para>
          </listitem>
        </varlistentry>
        <varlistentry>
         <term>cookie</term>
         <listitem>
          <para>
           Cookie para la sesión (proxy YAZ).
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>proxy</term>
         <listitem>
          <para>
           Proxy para la conexión (proxy YAZ).
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>persistent</term>
         <listitem>
          <para>
           Un booleano. Si es &true; la conexión es persistente; Si es &false; la
           conexión no es persistente. Por defecto las conexiones son persistentes.
          </para>
          <note>
           <para>
            Si se abre una conexión persistente, no se podrá cerrar
            posteriormente con la función <function>yaz_close</function>.
           </para>
          </note>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>piggyback</term>
         <listitem>
          <para>
           Un booleano. Si es &true; piggyback está activado para las búsquedas; Si es &false;
           piggyback está desactivado. Por defecto piggyback está activado.
          </para>
          <para>
           Activar piggyback es más eficiente y normalmente ahorra
           una ruta de ida y vuelta en la red para las cargas de los registros por primera vez. Sin embargo, unos
           pocos servidores Z39.50 no soportan piggyback o ignoran los
           nombres de los elementos configurados. Para ellos, se debe desactivar piggyback.
          </para>
         </listitem>
        </varlistentry>
        <varlistentry>
         <term>charset</term>
         <listitem>
          <para>
           Un string que especifica el mapa de caracteres que será utilizado como 
           lenguaje y mapa de caracteres en la negociación Z39.50. Utilizar strings como:
           <literal>ISO-8859-1</literal>, <literal>UTF-8</literal>, 
           <literal>UTF-16</literal>.
          </para>
          <para>
           Muchos servidores Z39.50 no soportan esta funcionalidad (y por ello, ésta es 
           ignorada). Muchos servidores utilizan la codificación ISO-8859-1 para consultas y
           mensajes. Los registros MARC21/USMARC no están afectados por este parámetro
          </para>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term>preferredMessageSize</term>
         <listitem>
          <para>
           Un entero que especifica el tamaño máximo de byte para todos los registros
           que se devolverán por el objetivo durante la recuperación. Ver el
           estandard <link xlink:href="&url.yaz.z3950.4;">Z39.50</link> para más
           información.
          </para>
          <note>
           <para>
            Esta opción está soportada en PECL YAZ 1.0.5 o posteriores.
           </para>
          </note>
         </listitem>
        </varlistentry>

        <varlistentry>
         <term>maximumRecordSize</term>
         <listitem>
          <para>
           Un entero que especifica el tamaño máximo de byte de un único registro
           a ser devuelto por un objetivo durante la recuperación. Esta
           entidad se denomina como un Exceptional-record-size en el 
          standard <link xlink:href="&url.yaz.z3950.4;">Z39.50</link>.
          </para>
          <note>
           <para>
            Esta opción está soportada en PECL YAZ 1.0.5 o posteriores.
           </para>
          </note>
         </listitem>
        </varlistentry>

       </variablelist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Un recurso de conexión en caso de éxito, &false; en caso de error.
  </para>
 </refsect1>
 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>4.1.0</entry>
       <entry>
        Se añadió el parámetro <parameter>options</parameter> .
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>yaz_close</function></member>
   </simplelist>
  </para>
 </refsect1>
</refentry>

<!-- 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
-->