<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Wait for Z39.50 requests to complete</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.yaz-syntax.html">yaz_syntax</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.nis.html">YP/NIS</a></div>
<div class="up"><a href="ref.yaz.html">YAZ Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.yaz-wait" class="refentry">
<div class="refnamediv">
<h1 class="refname">yaz_wait</h1>
<p class="verinfo">(PHP 4 >= 4.0.1, PECL yaz >= 0.9.0)</p><p class="refpurpose"><span class="refname">yaz_wait</span> — <span class="dc-title">Wait for Z39.50 requests to complete</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.yaz-wait-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>yaz_wait</strong></span>
([ <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$options</code></span>
] )</div>
<p class="para rdfs-comment">
This function carries out networked (blocked) activity for outstanding
requests which have been prepared by the functions
<span class="function"><a href="function.yaz-connect.html" class="function">yaz_connect()</a></span>, <span class="function"><a href="function.yaz-search.html" class="function">yaz_search()</a></span>,
<span class="function"><a href="function.yaz-present.html" class="function">yaz_present()</a></span>, <span class="function"><a href="function.yaz-scan.html" class="function">yaz_scan()</a></span> and
<span class="function"><a href="function.yaz-itemorder.html" class="function">yaz_itemorder()</a></span>.
</p>
<p class="para">
<span class="function"><strong>yaz_wait()</strong></span> returns when all servers have either
completed all requests or aborted (in case of errors).
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.yaz-wait-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">options</code></dt>
<dd>
<p class="para">
An associative array of options:
<dl>
<dt>
<em>timeout</em></dt>
<dd>
<p class="para">
Sets timeout in seconds. If a server has not responded within the
timeout it is considered dead and <span class="function"><strong>yaz_wait()</strong></span>
returns. The default value for timeout is 15 seconds.
</p>
</dd>
<dt>
<em>event</em></dt>
<dd>
<p class="para">
A boolean.
</p>
</dd>
</dl>
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.yaz-wait-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
In event mode, returns resource or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.yaz-syntax.html">yaz_syntax</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.nis.html">YP/NIS</a></div>
<div class="up"><a href="ref.yaz.html">YAZ Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
