$Sock Num - Revision history

JALWiccan: Automatically generated page update

2018-09-21T00:00:33Z

Automatically generated page update

← Older revision		Revision as of 00:00, 21 September 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_Num}}		{{DISPLAYTITLE:$Sock_Num}}
	<span class="pageSubtitle">Get selected socket numbers</span>		<span class="pageSubtitle">Get selected socket numbers</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_Num</var> is the <var>[[Num (Socket function)\|Num]]</var> method.</p>		methods. The OO equivalent for <var>$Sock_Num</var> is the <var>[[Num (Socket function)\|Num]]</var> method.</p>

JAL at 21:47, 23 July 2013

2013-07-23T21:47:41Z

← Older revision		Revision as of 21:47, 23 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Get selected socket numbers</span>		<span class="pageSubtitle">Get selected socket numbers</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_Num</var> is the <var>[[Num (Socket function)\|Num]]</var> method.</p>

	<var>$Sock_Num</var> retrieves selected socket numbers.		<var>$Sock_Num</var> retrieves selected socket numbers.

JALWiccan: Automatically generated page update

2013-07-19T18:59:25Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_Num}}		{{DISPLAYTITLE:$Sock_Num}}
	<span class="pageSubtitle">Get selected socket numbers</span>		<span class="pageSubtitle">Get selected socket numbers</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:46Z

1 revision

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

JAL at 19:42, 19 January 2012

2012-01-19T19:42:42Z

New page

{{DISPLAYTITLE:$Sock_Num}}
Get selected socket numbers
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for this $function.

<var>$Sock_Num</var> retrieves selected socket numbers.

==Syntax==
%nums = $Sock_Num[([selection])] 

===Syntax terms===
<table class="syntaxTable">
<tr><th>%nums</th>
<td>A string that contains blank-separated selected socket numbers in ascending order. </td></tr>
<tr><th>selection</th>
<td>A string that identifies which socket numbers to return. It is any combination of the following strings separated by '''OR''', and each optionally prefixed by '''NOT''':
<table class="syntaxTable">
<tr><th><var>ANY</var> </th>
<td>Return all sockets. This is the default. </td></tr>
<tr><th><var>CONN</var> </th>
<td>Return sockets enabled for sending in both directions. </td></tr>
<tr><th><var>FINR</var> </th>
<td>Return sockets on which local partner is enabled for sending but remote has stopped sending ("FIN received"). </td></tr> <tr><th><var>FINS</var> </th>
<td>Return sockets on which remote partner is enabled for sending but local stopped sending ("FIN sent"). </td></tr>
<tr><th><var>FINBOTH</var> </th>
<td>Return <code>OPEN</code> sockets on which remote and local partners both stopped sending ("FIN sent and received"). </td></tr>
<tr><th><var>RESET</var> </th>
<td>Return in-use but no longer connected sockets. </td></tr>
<tr><th><var>OPEN</var> </th>
<td>Return <code>OPEN</code> sockets. This is equivalent to either of the following:
<ul>
<li>NOT RESET
<li>CONN OR FINR OR FINS OR FINBOTH
</ul> </td></tr>
<tr><th><var>CAPTURE</var> </th>
<td>Return sockets (<code>OPEN</code> or not) for which print capturing is on. </td></tr>
<tr><th><var>CAPOPEN</var> </th>
<td>Return <code>OPEN</code> sockets for which print capturing is on. </td></tr>
</table>
If <var>NOT</var> prefixes one of the above specifications, then all in-use sockets (excluding the specified set) are included in the selected set. With multiple terms separated by <var>OR</var>, the specified sets are combined by the set union operation.
</table>

==Usage notes==
<var>$Sock_Num</var> does not have a socket number argument, and thus it is not affected by any <var>ONRESET</var> setting.

==Examples==
<ol>
<li>In the following example, <code>%sock</code> contains the blank-delimited values of <code>%c1</code> and <code>%c2</code>. Assuming no other client socket numbers were in use, this would result in <code>%sock = '2 3'</code>.
JANUS DEFINE PIPE * CLSOCK 5 REMOTE * * SOCKPMAX 2
Begin
%c1 is Float
%c2 is Float
%sock is String Len 255
%c1 = $Sock_conn('PIPE', 'www.ampas.org', 80)
%c2 = $Sock_conn('PIPE', 'www.wga.org', 80)
%sock = $Sock_Num ... 
<li>The following example shows another way to retrieve the list of all <code>OPEN</code> socket numbers:
%sock = $Sock_Num('NOT RESET') 
<li>The following example shows how to retrieve the list of all <code>OPEN</code> socket numbers that have not received the <var>FIN</var> indicator:
%sock = $Sock_Num('CONN OR FINS') 
</ol>

[[Category: Janus Sockets $functions]]