mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
89 lines
2.5 KiB
XML
89 lines
2.5 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.yaz-wait" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>yaz_wait</refname>
|
|
<refpurpose>Wait for Z39.50 requests to complete</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>yaz_wait</methodname>
|
|
<methodparam choice="opt"><type>array</type><parameter role="reference">options</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function carries out networked (blocked) activity for outstanding
|
|
requests which have been prepared by the functions
|
|
<function>yaz_connect</function>, <function>yaz_search</function>,
|
|
<function>yaz_present</function>, <function>yaz_scan</function> and
|
|
<function>yaz_itemorder</function>.
|
|
</para>
|
|
<para>
|
|
<function>yaz_wait</function> returns when all servers have either
|
|
completed all requests or aborted (in case of errors).
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>options</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
An associative array of options:
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><literal>timeout</literal></term>
|
|
<listitem>
|
|
<para>
|
|
Sets timeout in seconds. If a server has not responded within the
|
|
timeout it is considered dead and <function>yaz_wait</function>
|
|
returns. The default value for timeout is 15 seconds.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><literal>event</literal></term>
|
|
<listitem>
|
|
<para>
|
|
A boolean.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
In event mode, returns resource &return.falseforfailure;.
|
|
</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
|
|
-->
|