<doc>
  <legacy_id>1747</legacy_id>
  <name>socketTimeoutInterval</name>
  <type>property</type>
  <syntax>
    <example>set the socketTimeoutInterval to <i>milliseconds</i></example>
  </syntax>
  <library></library>
  <objects>
    <global/>
  </objects>
  <synonyms>
  </synonyms>
  <classification>
    <category>Networks &amp; Communication</category>
  </classification>
  <references>
    <message tag="socketTimeout">socketTimeout Message</message>
  </references>
  <history>
    <introduced version="1.0">Added.</introduced>
  </history>
  <platforms>
    <mac/>
    <windows/>
    <linux/>
  </platforms>
  <classes>
    <desktop/>
    <server/>
    <web/>
  </classes>
  <security>
  </security>
  <summary>Specifies how long to wait for a <command tag="read from socket">read from socket</command> or <command tag="write to socket">write to socket</command> <glossary tag="command">command</glossary> to finish before <glossary tag="timeout">timing out</glossary>.</summary>
  <examples>
    <example>set the socketTimeoutInterval to 100 <i>-- one-tenth of a second</i></example>
  </examples>
  <description>
    <p>Use the <b>socketTimeoutInterval</b> to specify a time to wait for <glossary tag="socket">socket</glossary> actions to complete.</p><p/><p><b>Value:</b></p><p>The <b>socketTimeoutInterval</b> is a positive <keyword tag="integer">integer</keyword>.</p><p/><p>By default, the <b>socketTimeoutInterval</b> is 10000 (ten seconds).</p><p/><p><b>Comments:</b></p><p>If the <b>socketTimeoutInterval</b> passes and no data has been transmitted yet, the <message tag="socketTimeout">socketTimeout</message> <keyword tag="message box">message</keyword> is sent to the <glossary tag="object">object</glossary> whose <property tag="script">script</property> contains the <command tag="read from socket">read from socket</command> or <command tag="write to socket">write to socket</command> <glossary tag="command">command</glossary>.</p><p/><p>LiveCode checks the <b>socketTimeoutInterval</b> every time a <command tag="read from socket">read from socket</command> or <command tag="write to socket">write to socket</command> <glossary tag="command">command</glossary> is <glossary tag="execute">executed</glossary>, so you can specify different intervals for different <glossary tag="command">commands</glossary> by changing the <b>socketTimeoutInterval</b> before issuing the <glossary tag="command">command</glossary>.</p><p/><p>As long as the action is still pending, the <b>socketTimeout</b> <keyword tag="message box">message</keyword> is sent every time the <b>socketTimeoutInterval</b> elapses. For example, if the <b>socketTimeoutInterval</b> is 1000 <function tag="milliseconds">milliseconds</function> (one second), a <message tag="socketTimeout">socketTimeout</message> <keyword tag="message box">message</keyword> is sent every second until the action completes.</p>
  </description>
</doc>