Files
doc-fr/reference/yaz/functions/yaz-connect.xml
T
Yannick Torres 816033f7c7 Convert to UTF-8
git-svn-id: https://svn.php.net/repository/phpdoc/fr/trunk@297783 c90b9560-bf6c-de11-be94-00142212c4b1
2010-04-10 07:39:12 +00:00

260 lines
7.7 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: jsgoupil Status: ready -->
<!-- Reviewed: yes -->
<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>Prépare une connexion à un serveur 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>
Cette fonction retourne une ressource de connexion en cas de succès et
&zero; en cas d'échec.
</para>
<para>
<function>yaz_connect</function> prépare une connexion
à un serveur Z39.50. Cette fonction n'est pas bloquante,
et ne tente pas d'établir une connexion. En fait, elle ne fait que
préparer la connexion pour exécution ultérieure
par <function>yaz_wait</function>.
</para>
<note>
<para>
Le proxy <link xlink:href="&url.yaz-proxy;">YAZ</link> est un proxy Z39.50 librement
disponible.
</para>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>zurl</parameter></term>
<listitem>
<para>
Une chaîne de caractères qui prend la forme
<literal>host[:port][/database]</literal>. Si le port est omis, le port
210 est utilisé. Si la base de données est omise,
<literal>Default</literal> est utilisée.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Si donné comme une chaîne de caractères, cela sera traité comme la
chaîne d'authentification Z39.50 V2 (OpenAuth).
</para>
<para>
Si donné comme un tableau, le contenu du tableau sert en tant
qu'options.
<variablelist>
<varlistentry>
<term>user</term>
<listitem>
<para>
Utilisateur pour authentification.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>group</term>
<listitem>
<para>
Groupe pour authentification.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>password</term>
<listitem>
<para>
Mot de passe pour authentification.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>cookie</term>
<listitem>
<para>
Cookie pour session (proxy YAZ).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>proxy</term>
<listitem>
<para>
Proxy pour connexion (proxy YAZ).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>persistent</term>
<listitem>
<para>
Un booléen. Si &true; la connexion est persistante; Si &false; la
connexion n'est pas persistante. Par défaut les connexions sont
persistantes.
</para>
<note>
<para>
Si vous ouvrez une connexion persistante, vous ne serez pas
capable de la fermer plus tard avec
<function>yaz_close</function>.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>piggyback</term>
<listitem>
<para>
Un booléen. Si &true; piggyback est activé pour les recherches. Si
&false; piggyback est désactivé. Par défaut piggyback est activé.
</para>
<para>
L'activation de piggyback est plus efficace : il sauvegarde
habituellement les allers-retours du réseau pour les premières
lectures de résultats. Cependant, quelque serveurs Z39.50 ne
supportent pas piggyback ou ils ignorent ce jeu de noms. Pour ceux-ci,
piggyback devrait être désactivé.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>charset</term>
<listitem>
<para>
Une chaîne de caractères qui spécifie le jeu de caractères qui sera
utilisé dans le langage Z39.50 et le jeu de caractères pour les
négociations. Utilisez une chaîne de caractères comme :
<literal>ISO-8859-1</literal>, <literal>UTF-8</literal>,
<literal>UTF-16</literal>.
</para>
<para>
La plupart des serveurs Z39.50 ne supportent pas cette option (et,
pour ceux-ci, cet argument est ignoré). Plusieurs serveurs
utilisent l'encodage ISO-8859-1 pour les requêtes et les messages.
Les enregistrements MARC21/USMARC ne sont pas affectés par cette
configuration.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>preferredMessageSize</term>
<listitem>
<para>
Un entier qui spécifie la taille maximale en octets pour toutes les
entrées qui seront retournées par la cible durant la récupération.
Voyez le <link xlink:href="&url.yaz.z3950.4;">standard Z39.50</link>
pour plus d'informations.
</para>
<note>
<para>
Cette option est supportée dans PECL YAZ 1.0.5 ou supérieure.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term>maximumRecordSize</term>
<listitem>
<para>
Un entier qui spécifie la taille maximale en octets pour une seule
entrée qui sera retournée par la cible durant la récupération.
Cette entité est référée à Exceptional-record-size dans le <link
xlink:href="&url.yaz.z3950.4;">standard Z39.50</link>.
</para>
<note>
<para>
Cette option est supportée dans PECL YAZ 1.0.5 ou supérieure.
</para>
</note>
</listitem>
</varlistentry>
</variablelist>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Une ressource de connexion en cas de réussite, &false; en cas d'erreur.
</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>
Le paramètre <parameter>options</parameter> a été ajouté.
</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
-->