$Sock Close: Difference between revisions
Jump to navigation
Jump to search
(Automatically generated page update) |
mNo edit summary |
||
| 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. | 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, | ||
Revision as of 21:35, 23 July 2013
Close Janus Sockets connection(s)
Note: Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for $Sock_Close is the Close method.
$Sock_Close terminates the sending and receiving of data on, and removes from use, one or all Janus Sockets connection(s).
Syntax
[%num =]$Sock_Close[([sockNum])]
Syntax terms
| %num | The number of of connections closed. |
|---|---|
| sockNum | 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. |
Usage notes
- If socket is -1, indicating that all sockets are affected by the $Sock_Close call, then the returned number %num will be the number of sockets in use. Otherwise
1is returned. - $Sock_Close is not affected by any ONRESET setting.
Examples
- In the following example, the $Sock_Close call signals that the program has completed all processing on the socket identified by the value in
%sock:%count = $Sock_Close(%sock)
- The following call closes all socket connections the user has:
%count = $Sock_Close(-1)