<doc>
	<legacy_id>1288</legacy_id>
	<name>socketTimeout</name>
	<type>message</type>

	<syntax>
		<example>socketTimeout <i>socketID</i></example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Sent when an <command tag="open socket">open socket</command>, <command tag="read from socket">read from socket</command> or <command tag="write to socket">write to socket</command> <glossary tag="command">command</glossary> halts for the time specified by the <property tag="socketTimeoutInterval">socketTimeoutInterval</property> <glossary tag="property">property</glossary>.  </summary>

	<examples>
<example><p>on socketTimeout theID</p><p>  answer error &quot;The connnection is not responding.&quot; \</p><p>     with &quot;Keep Trying&quot; or &quot;Cancel&quot;</p><p>  if it is &quot;Cancel&quot; then close socket theID</p><p>end if</p></example>
	</examples>

	<history>
		<introduced version="1.0">Added.  </introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		
	</history>

	<objects>
		<stack/>
		<card/>
		<group/>
		<field/>
		<button/>
		<graphic/>
		<scrollbar/>
		<player/>
		<image/>
	</objects>

	<platforms>
		<mac/>
		<windows/>
		<linux/>
	</platforms>

	<classes>
		<desktop/>
		<server/>
		<web/>
	</classes>

	<security>
	</security>


	<classification>
	</classification>

	<references>
		<function tag="openSockets">openSockets Function</function>
		<command tag="close socket">close socket Command</command>
		<command tag="open socket">open socket Command</command>
		<command tag="read from socket">read from socket Command</command>
		<command tag="write to socket">write to socket Command</command>
		<property tag="socketTimeoutInterval">socketTimeoutInterval Property</property>
		<message tag="socketError">socketError Message</message>
		<message tag="socketClosed">socketClosed Message</message>
	</references>

	<description>
	<overview>Handle the <b>socketTimeout</b> <keyword tag="message box">message</keyword> to take action when a <glossary tag="socket">socket</glossary> communication has not completed within the time set by the <property tag="socketTimeoutInterval">socketTimeoutInterval</property>.  </overview>

		<parameters>
		<parameter>The <i>socketID</i> is the identifier (set when you opened the socket) of the socket which had an error.</parameter>
		<parameter> </parameter>
		<parameter>The socket identifier starts with the IP address of the host the socket is connected to, and may optionally include a port number (separated from the IP address by a colon). If there is more than one socket connected to that host and port, you can specify which socket by appending the connection name or number that was assigned when the socket was opened, separated from the port number by a vertical bar (|).</parameter>
		</parameters>

	<value></value>
	<comments>The <b>socketTimeout</b> message is sent to the object whose script created the socket. </comments>
	</description>
</doc>