Num (Socket function) - Revision history

JAL: typo

2018-01-26T16:07:03Z

typo

← Older revision		Revision as of 16:07, 26 January 2018
Line 100:		Line 100:
	</p>		</p>
	</ol>		</ol>

	~~{{Template:Socket:Num subtitle}}~~

JALWiccan: Automatically generated page update

2014-02-16T00:59:22Z

Automatically generated page update

← Older revision		Revision as of 00:59, 16 February 2014
Line 15:		Line 15:
	<td>Return string, which is to contain blank-separated socket numbers.		<td>Return string, which is to contain blank-separated socket numbers.
	</td></tr>		</td></tr>
	<tr><th><var>%(Socket)</var></th>		<tr><th><var class="nobr">%(Socket)</var></th>
	<td>The class name in parentheses denotes a shared method. <var>Num</var> can also be invoked via a <var>Socket</var> object variable, which may be <var>Null</var>.</td></tr>		<td>The class name in parentheses denotes a shared method. <var>Num</var> can also be invoked via a <var>Socket</var> object variable, which may be <var>Null</var>.</td></tr>
	<tr><th>string</th>		<tr><th>string</th>

JAL2: /* Syntax terms */

2011-11-22T01:09:55Z

Syntax terms

← Older revision		Revision as of 01:09, 22 November 2011
Line 16:		Line 16:
	</td></tr>		</td></tr>
	<tr><th><var>%(Socket)</var></th>		<tr><th><var>%(Socket)</var></th>
	<td>The class name in parentheses denotes a shared method. ~~Specifying~~ <~~code~~>%(Socket):</~~code~~> ~~is not the only way to invoke the method (see [[??]] refid=themeth.)~~.		<td>The class name in parentheses denotes a shared method. <var>Num</var> can also be invoked via a <var>Socket</var> object variable, which may be <var>Null</var>.</td></tr>
	</td></tr>
	<tr><th>string</th>		<tr><th>string</th>
	<td>The socket numbers to return: any combination of the following strings separated by <code>OR</code>, and each optionally prefixed by <code>NOT</code>: <table class="syntaxTable"> <tr><th><var>ANY</var> </th><td>Return all in-use sockets [default].		<td>The socket numbers to return: any combination of the following strings separated by <code>OR</code>, and each optionally prefixed by <code>NOT</code>: <table class="syntaxTable"> <tr><th><var>ANY</var> </th><td>Return all in-use sockets [default].

JAL2: /* Syntax terms */

2011-11-15T01:56:14Z

Syntax terms

← Older revision		Revision as of 01:56, 15 November 2011
Line 12:		Line 12:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~numstr~~</th>		<tr><th>%string</th>
	<td>Return string, which is to contain blank-separated socket numbers.		<td>Return string, which is to contain blank-separated socket numbers.
	</td></tr>		</td></tr>
Line 18:		Line 18:
	<td>The class name in parentheses denotes a shared method. Specifying <code>%(Socket):</code> is not the only way to invoke the method (see [[??]] refid=themeth.).		<td>The class name in parentheses denotes a shared method. Specifying <code>%(Socket):</code> is not the only way to invoke the method (see [[??]] refid=themeth.).
	</td></tr>		</td></tr>
	<tr><th>~~selection~~</th>		<tr><th>string</th>
	<td>The socket numbers to return: any combination of the following strings separated by <code>OR</code>, and each optionally prefixed by <code>NOT</code>: <table class="syntaxTable"> <tr><th><var>ANY</var> </th><td>Return all in-use sockets [default].		<td>The socket numbers to return: any combination of the following strings separated by <code>OR</code>, and each optionally prefixed by <code>NOT</code>: <table class="syntaxTable"> <tr><th><var>ANY</var> </th><td>Return all in-use sockets [default].
	</td></tr>		</td></tr>

JAL2 at 23:09, 14 November 2011

2011-11-14T23:09:24Z

← Older revision		Revision as of 23:09, 14 November 2011
Line 1:		Line 1:
			{{Template:Socket:Num subtitle}}
	~~<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>~~
	~~[[Category~~:Socket ~~methods\|Num function]]~~
	~~<p>~~
	~~<var>~~Num~~</var> is a member of the <var>[[Socket class\|Socket]]</var> class.~~
	~~</p>~~

	This [[Notation conventions for methods#Shared members\|shared]] method retrieves the socket numbers		This [[Notation conventions for methods#Shared members\|shared]] method retrieves the socket numbers
Line 11:		Line 6:
	it implicitly executes a <var>[[GetSocketNumber (Socket function)\|GetSocketNumber]]</var>.		it implicitly executes a <var>[[GetSocketNumber (Socket function)\|GetSocketNumber]]</var>.
	The <var>Num</var> function has an effect similar to <var>[[$Sock_Num]]</var>.		The <var>Num</var> function has an effect similar to <var>[[$Sock_Num]]</var>.

	==Syntax==		==Syntax==
	~~<p class="syntax">%numstr = %(~~Socket):Num~~[(selection)]~~		{{Template:Socket:Num syntax}}
	~~</p>~~
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 105:		Line 101:
	</p>		</p>
	</ol>		</ol>

			{{Template:Socket:Num subtitle}}

JAL2: /* Syntax terms */

2011-11-08T22:32:52Z

Syntax terms

← Older revision		Revision as of 22:32, 8 November 2011
Line 19:		Line 19:
	<td>Return string, which is to contain blank-separated socket numbers.		<td>Return string, which is to contain blank-separated socket numbers.
	</td></tr>		</td></tr>
	<tr><th>%(Socket)</th>		<tr><th><var>%(Socket)</var></th>
	<td>The class name in parentheses denotes a shared method. Specifying <code>%(Socket):</code> is not the only way to invoke the method (see [[??]] refid=themeth.).		<td>The class name in parentheses denotes a shared method. Specifying <code>%(Socket):</code> is not the only way to invoke the method (see [[??]] refid=themeth.).
	</td></tr>		</td></tr>

Admin: 1 revision

2011-11-08T21:35:41Z

1 revision

← Older revision	Revision as of 21:35, 8 November 2011
(No difference)

JAL: /* Examples */

2011-11-08T20:50:23Z

Examples

New page

<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:Socket methods|Num function]]
<p>
<var>Num</var> is a member of the <var>[[Socket class|Socket]]</var> class.
</p>

This [[Notation conventions for methods#Shared members|shared]] method retrieves the socket numbers
of the set of sockets you select.
For <var>Socket</var> objects,
it implicitly executes a <var>[[GetSocketNumber (Socket function)|GetSocketNumber]]</var>.
The <var>Num</var> function has an effect similar to <var>[[$Sock_Num]]</var>.
==Syntax==
<p class="syntax">%numstr = %(Socket):Num[(selection)]
</p>
===Syntax terms===
<table class="syntaxTable">
<tr><th>%numstr</th>
<td>Return string, which is to contain blank-separated socket numbers.
</td></tr>
<tr><th>%(Socket)</th>
<td>The class name in parentheses denotes a shared method. Specifying <code>%(Socket):</code> is not the only way to invoke the method (see [[??]] refid=themeth.).
</td></tr>
<tr><th>selection</th>
<td>The socket numbers to return: any combination of the following strings separated by <code>OR</code>, and each optionally prefixed by <code>NOT</code>: <table class="syntaxTable"> <tr><th><var>ANY</var> </th><td>Return all in-use sockets [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 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 <var>OPEN</var> 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 <var>OPEN</var> sockets; this is equivalent to either of the following:
<ul>
<li><code>NOT RESET</code>
<li><code>CONN OR FINR OR FINS OR FINBOTH</code> </ul>
</td></tr>
<tr><th><var>CAPTURE</var>
</th><td>Return sockets (<var>OPEN</var> or not) for which print capturing is on.
</td></tr>
<tr><th><var>CAPOPEN</var>
</th><td>Return <var>OPEN</var> sockets for which print capturing is on.
</td></tr></table>
If <code>NOT</code> prefixes one of the above specifications, all
in-use sockets (<i>excluding</i> the specified set) are included in the selected set.
With multiple terms separated by <code>OR</code>, the specified sets are
combined by the set union operation.

</td></tr></table>

==Usage notes==
<ul>
<li>The <var>Num</var> method returns a blank-delimited string containing
the numbers of the requested sockets in ascending order.
<li>The <var>Num</var> method is not affected by any <var>ONRESET</var> setting.
</ul>

==Examples==
<ol>
<li>In the following example, <code>%nums</code> contains the blank-delimited
numbers of (all) the open sockets:
<p class="code">JANUS DEFINE PIPE * CLSOCK 5 REMOTE * * SOCKPMAX 2
JANUS START PIPE
Begin
%nums Is String Len 255
%sockamp object <var>Socket</var>
%sockwga object <var>Socket</var>

%sockamp = New('PIPE', 'www.ampas.org', 80)
If %sockamp Is Null Then
Print 'Error:' And $STATUSD
Stop
End If
%sockwga = New('PIPE', 'www.wga.org', 80)
If %sockwga Is Null Then
Print 'Error:' And $STATUSD
Stop
End If
%nums = %(Socket):Num
Print 'The socket numbers are: ' %nums
%sockamp:Close
%sockwga:Close
End
</p>

The example result is:
<p class="code">The socket numbers are: 2 3
</p>
<li>The following example shows another way to retrieve the list of all <var>OPEN</var> socket numbers:
<p class="code">%nums = %(Socket):Num('NOT RESET')
</p>
<li>The following example shows how to retrieve the list of all <var>OPEN</var>
socket numbers that have not received the <var>FIN</var> indicator:
<p class="code">%nums = %(Socket):Num('CONN OR FINS')
</p>
</ol>