$Sock Close - Revision history

JALWiccan: Automatically generated page update

2018-09-21T00:00:31Z

Automatically generated page update

← Older revision		Revision as of 00:00, 21 September 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_Close}}		{{DISPLAYTITLE:$Sock_Close}}
	<span class="pageSubtitle">Close Janus Sockets connection(s)</span>		<span class="pageSubtitle">Close Janus Sockets connection(s)</span>
	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented
	methods. The OO equivalent for <var>$Sock_Close</var> is the <var>[[Close (Socket function)\|Close]]</var> method.</p>		methods. The OO equivalent for <var>$Sock_Close</var> is the <var>[[Close (Socket function)\|Close]]</var> method.</p>

JAL at 21:35, 23 July 2013

2013-07-23T21:35:53Z

← Older revision		Revision as of 21:35, 23 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Close Janus Sockets connection(s)</span>		<span class="pageSubtitle">Close Janus Sockets connection(s)</span>
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented
	methods. ~~There is currently no direct~~ OO equivalent for ~~this~~ $function.</p>		methods. The OO equivalent for <var>$Sock_Close</var> is the <var>[[Close (Socket function)\|Close]]</var> method.</p>

	<var>$Sock_Close</var> terminates the sending and receiving of data on, and removes from use,		<var>$Sock_Close</var> terminates the sending and receiving of data on, and removes from use,

JALWiccan: Automatically generated page update

2013-07-19T18:59:23Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_Close}}		{{DISPLAYTITLE:$Sock_Close}}
	<span class="pageSubtitle">Close Janus Sockets connection(s)</span>		<span class="pageSubtitle">Close Janus Sockets connection(s)</span>
	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented
	methods. There is currently no direct OO equivalent for this $function.</p>		methods. There is currently no direct OO equivalent for this $function.</p>

Admin: 1 revision

2012-01-20T02:53:45Z

1 revision

← Older revision	Revision as of 02:53, 20 January 2012
(No difference)

JAL at 21:18, 19 January 2012

2012-01-19T21:18:47Z

New page

{{DISPLAYTITLE:$Sock_Close}}
Close Janus Sockets connection(s)
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for this $function.

<var>$Sock_Close</var> terminates the sending and receiving of data on, and removes from use,
one or all <var class="product">Janus Sockets</var> connection(s).

==Syntax==
[%num =]$Sock_Close[([sockNum])] 

===Syntax terms===
<table class="syntaxTable">
<tr><th>%num</th>
<td>The number of of connections closed.</td></tr>
<tr><th>sockNum</th>
<td>The number of a socket that is to be closed, or the value -1, which indicates that all the user's sockets should be closed. The default value of this optional argument is -1. </td></tr>
</table>

==Usage notes==
<ul>
<li>If <var class="term">socket</var> is -1, indicating that all sockets are affected by the <var>$Sock_Close</var> call, then the returned number <var class="term">%num</var> will be the number of sockets in use. Otherwise <code>1</code> is returned.
<li><var>$Sock_Close</var> is not affected by any <var>ONRESET</var> setting.
</ul>

==Examples==
<ol>
<li>In the following example, the <var>$Sock_Close</var> call signals that the program has completed all processing on the socket identified by the value in <code>%sock</code>:
%count = $Sock_Close(%sock) 
<li>The following call closes all socket connections the user has:
%count = $Sock_Close(-1) 
</ol>

[[Category: Janus Sockets $functions]]