<doc>

<legacy_id>1387</legacy_id>

<name>close socket</name>

<type>command</type>

<syntax>

<example>close socket <i>socketID</i></example>

</syntax>

<library></library>

<objects>

</objects>

<synonyms>

</synonyms>

<classification>

<category>Networks &amp; Communication</category>

</classification>

<references>

<command tag="accept">accept Command</command>

<command tag="resetAll">resetAll Command</command>

<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>

<network/>

</security>

<summary>Shuts down a connection that was opened with the <command tag="open socket">open socket</command> or <command tag="accept">accept</command> <glossary tag="command">command</glossary>.</summary>

<examples>

<example>close socket "127.0.0.0"</example>

<example>close socket "www.example.net:8080|newConnection"</example>

<example>close socket (line 1 of the openSockets)</example>

</examples>

<description>

<p>Use the <b>close socket</b> <glossary tag="command">command</glossary> to release the connection when you're finished getting and sending data over it.</p><p/><p><b>Parameters:</b></p><p>The <i>socketID</i> is the identifier (set when you opened the <glossary tag="socket">socket</glossary>) of the <glossary tag="socket">socket</glossary> you want to close.</p><p/><p>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 <glossary tag="port">port number</glossary> by a vertical bar (<code>|</code><a/>).</p>

</description>

</doc>