<?xml version="1.0" encoding="UTF-8"?>

<!--
 * 
 * This help file was generated from lcaGetTimeout.sci using help_from_sci().
 * 
 -->

<refentry version="5.0-subset Scilab" xml:id="lcaGetTimeout" xml:lang="en"
          xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:ns3="http://www.w3.org/1999/xhtml"
          xmlns:mml="http://www.w3.org/1998/Math/MathML"
          xmlns:db="http://docbook.org/ns/docbook">

  <info>
    <pubdate>$LastChangedDate: 13-Jan-2012 $</pubdate>
  </info>

  <refnamediv>
    <refname>lcaGetTimeout</refname><refpurpose>Get/set the ezca libary timeout. The total timeout is this value multiplied by the retry count</refpurpose>
  </refnamediv>



<refsynopsisdiv>
   <title>Calling Sequence</title>
   <synopsis>
   currentTimeout = lcaGetTimeout()
   </synopsis>
</refsynopsisdiv>

<refsection>
   <title>Description</title>
   <para>
Retrieve the ezca library timeout parameter (consult the ezca
documentation for more information).
<note>
<para>
The semantics of the
timeout parameter has changed with labCA version 3. The library no
longer pends for CA activity in multiples of this timeout value but
returns control to scilab as soon as the underlying CA request
completes.
</para><para>
However, labCA checks for ``Ctrl-C'' key events every time (and only
when) the timeout expires. Hence, it is convenient to choose a value
&lt;1 s.
</para>
</note>
   </para>
   <para>
The maximal time spent waiting for connections and/or data equals the
timeout multiplied by the <link linkend='lcaGetRetryCount'>retry</link> count.
</para>
</refsection>

<refsection>
   <title>See also</title>
   <simplelist type="inline">
   <member><link linkend="lcaSetTimeout">lcaSetTimeout</link></member>
   <member><link linkend="lcaGetRetryCount">lcaGetRetryCount</link></member>
   <member><link linkend="lcaSetRetryCount">lcaSetRetryCount</link></member>
   </simplelist>
</refsection>
</refentry>
