mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
245 lines
7 KiB
XML
245 lines
7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<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>
|
|
Prepares for a connection to a Z39.50 server
|
|
</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>
|
|
This function returns a connection resource on success, zero on
|
|
failure.
|
|
</para>
|
|
<para>
|
|
<function>yaz_connect</function> prepares for a connection to a
|
|
Z39.50 server.
|
|
This function is non-blocking and does not attempt to establish
|
|
a connection - it merely prepares a connect to be performed later when
|
|
<function>yaz_wait</function> is called.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
The <link xlink:href="&url.yaz-proxy;">YAZ proxy</link> is a
|
|
freely available Z39.50 proxy.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>zurl</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A string that takes the form <literal>host[:port][/database]</literal>.
|
|
If port is omitted, port 210 is used. If database is omitted
|
|
<literal>Default</literal> is used.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If given as a string, it is treated as the Z39.50 V2 authentication
|
|
string (OpenAuth).
|
|
</para>
|
|
<para>
|
|
If given as an array, the contents of the array serves as options.
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>user</term>
|
|
<listitem>
|
|
<para>
|
|
Username for authentication.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>group</term>
|
|
<listitem>
|
|
<para>
|
|
Group for authentication.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>password</term>
|
|
<listitem>
|
|
<para>
|
|
Password for authentication.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>cookie</term>
|
|
<listitem>
|
|
<para>
|
|
Cookie for session (YAZ proxy).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>proxy</term>
|
|
<listitem>
|
|
<para>
|
|
Proxy for connection (YAZ proxy).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>persistent</term>
|
|
<listitem>
|
|
<para>
|
|
A boolean. If &true; the connection is persistent; If &false; the
|
|
connection is not persistent. By default connections are persistent.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
If you open a persistent connection, you won't be able to close
|
|
it later with <function>yaz_close</function>.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>piggyback</term>
|
|
<listitem>
|
|
<para>
|
|
A boolean. If &true; piggyback is enabled for searches; If &false;
|
|
piggyback is disabled. By default piggyback is enabled.
|
|
</para>
|
|
<para>
|
|
Enabling piggyback is more efficient and usually saves a
|
|
network-round-trip for first time fetches of records. However, a
|
|
few Z39.50 servers do not support piggyback or they ignore element
|
|
set names. For those, piggyback should be disabled.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>charset</term>
|
|
<listitem>
|
|
<para>
|
|
A string that specifies character set to be used in Z39.50
|
|
language and character set negotiation. Use strings such as:
|
|
<literal>ISO-8859-1</literal>, <literal>UTF-8</literal>,
|
|
<literal>UTF-16</literal>.
|
|
</para>
|
|
<para>
|
|
Most Z39.50 servers do not support this feature (and thus, this is
|
|
ignored). Many servers use the ISO-8859-1 encoding for queries and
|
|
messages. MARC21/USMARC records are not affected by this setting.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>preferredMessageSize</term>
|
|
<listitem>
|
|
<para>
|
|
An integer that specifies the maximum byte size of all records
|
|
to be returned by a target during retrieval. See the
|
|
<link xlink:href="&url.yaz.z3950.4;">Z39.50 standard</link> for more
|
|
information.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
This option is supported in PECL YAZ 1.0.5 or later.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>maximumRecordSize</term>
|
|
<listitem>
|
|
<para>
|
|
An integer that specifies the maximum byte size of a single record
|
|
to be returned by a target during retrieval. This
|
|
entity is referred to as Exceptional-record-size in the
|
|
<link xlink:href="&url.yaz.z3950.4;">Z39.50 standard</link>.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
This option is supported in PECL YAZ 1.0.5 or later.
|
|
</para>
|
|
</note>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
A connection resource on success, &false; on 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>
|
|
The parameter <parameter>options</parameter> was added.
|
|
</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
|
|
-->
|