php-doc-en/reference/yaz/functions/yaz-wait.xml
2003-06-15 15:21:05 +00:00

62 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/yaz.xml, last change in rev 1.15 -->
<refentry id="function.yaz-wait">
<refnamediv>
<refname>yaz_wait</refname>
<refpurpose>Wait for Z39.50 requests to complete</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>yaz_wait</methodname>
<methodparam choice="opt"><type>array</type><parameter>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>.
<function>yaz_wait</function> returns when all targets have either
completed all requests or aborted (in case of errors).
</para>
<para>
If the <parameter>options</parameter> array is given that holds
options that change the behaviour of <function>yaz_wait</function>.
</para>
<variablelist>
<varlistentry>
<term><literal>timeout</literal></term>
<listitem>
<para>
Sets timeout in seconds. If a target 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>
</variablelist>
</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:"../../../../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
-->