OnReset (Socket function) - Revision history

JALWiccan: Automatically generated page update

2014-02-16T00:59:28Z

Automatically generated page update

← Older revision		Revision as of 00:59, 16 February 2014
Line 15:		Line 15:
	<td>Numeric return string, which is to contain 0 (success) or a negative integer (see <var class="term">label</var>, below).		<td>Numeric return string, which is to contain 0 (success) or a negative integer (see <var class="term">label</var>, below).
	</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>OnReset</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>OnReset</var> can also be invoked via a <var>Socket</var> object variable, which may be <var>Null</var>.</td></tr>
	<tr><th>label</th>		<tr><th>label</th>

JAL2 at 20:55, 20 January 2012

2012-01-20T20:55:27Z

← Older revision		Revision as of 20:55, 20 January 2012
Line 5:		Line 5:
	when a <var>RESET</var> socket is encountered in the current or a lower program scope.		when a <var>RESET</var> socket is encountered in the current or a lower program scope.
	It can also be used to clear without replacing an existing <var>ONRESET</var> label.		It can also be used to clear without replacing an existing <var>ONRESET</var> label.
	The <var>OnReset</var> function has an effect similar to <var>[[$~~Sock_Onreset~~]]</var>.		The <var>OnReset</var> function has an effect similar to <var>[[$Sock_OnReset]]</var>.

	==Syntax==		==Syntax==

JAL2: /* Syntax terms */

2011-11-22T01:10:46Z

Syntax terms

← Older revision		Revision as of 01:10, 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>OnReset</var> can also be invoked via a <var>Socket</var> object variable, which may be <var>Null</var>.</td></tr>
	</td></tr>
	<tr><th>label</th>		<tr><th>label</th>
	<td>The label in the program to which to jump to for <var>ONRESET</var> handling. If <var class="term">label</var> is the null string or all blanks, any existing <var>ONRESET</var> label in the current scope is cleared, and <var>OnReset</var> returns: <ul> <li>-3, if <var>OnReset</var> is issued from an <var>ON</var> unit <li>-1, otherwise </ul>		<td>The label in the program to which to jump to for <var>ONRESET</var> handling. If <var class="term">label</var> is the null string or all blanks, any existing <var>ONRESET</var> label in the current scope is cleared, and <var>OnReset</var> returns: <ul> <li>-3, if <var>OnReset</var> is issued from an <var>ON</var> unit <li>-1, otherwise </ul>

JAL2: /* Syntax terms */

2011-11-15T01:57:22Z

Syntax terms

← Older revision		Revision as of 01:57, 15 November 2011
Line 12:		Line 12:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%rc</th>		<tr><th>%number</th>
	<td>Numeric return string, which is to contain 0 (success) or a negative integer (see <var class="term">label</var>, below).		<td>Numeric return string, which is to contain 0 (success) or a negative integer (see <var class="term">label</var>, below).
	</td></tr>		</td></tr>

JAL2 at 23:10, 14 November 2011

2011-11-14T23:10:44Z

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

	This callable, [[Notation conventions for methods#Shared members\|shared]] method		This callable, [[Notation conventions for methods#Shared members\|shared]] method
Line 11:		Line 6:
	It can also be used to clear without replacing an existing <var>ONRESET</var> label.		It can also be used to clear without replacing an existing <var>ONRESET</var> label.
	The <var>OnReset</var> function has an effect similar to <var>[[$Sock_Onreset]]</var>.		The <var>OnReset</var> function has an effect similar to <var>[[$Sock_Onreset]]</var>.

	==Syntax==		==Syntax==
	~~<p class="syntax">%rc = %(~~Socket):OnReset~~[('label')]~~		{{Template:Socket:OnReset syntax}}
	~~</p>~~
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 80:		Line 76:
	Stop		Stop
	</p>		</p>

			{{Template:Socket:OnReset footer}}

JAL2: /* Syntax terms */

2011-11-08T22:33:38Z

Syntax terms

← Older revision		Revision as of 22:33, 8 November 2011
Line 19:		Line 19:
	<td>Numeric return string, which is to contain 0 (success) or a negative integer (see <var class="term">label</var>, below).		<td>Numeric return string, which is to contain 0 (success) or a negative integer (see <var class="term">label</var>, below).
	</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>
Line 26:		Line 26:

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

	==Usage notes==		==Usage notes==
	<ul>		<ul>

Admin: 1 revision

2011-11-08T21:35:41Z

1 revision

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

198.242.244.47: Created page with "
OnReset function
`OnReset` is a member of the `[[..."`

2011-11-08T19:34:01Z

Created page with " <span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span> OnReset function <p> <var>OnReset</var> is a member of the <var>[[..."

New page

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

This callable, [[Notation conventions for methods#Shared members|shared]] method
specifies the label in the <var class="product">User Language</var> sockets program to jump to
when a <var>RESET</var> socket is encountered in the current or a lower program scope.
It can also be used to clear without replacing an existing <var>ONRESET</var> label.
The <var>OnReset</var> function has an effect similar to <var>[[$Sock_Onreset]]</var>.
==Syntax==
<p class="syntax">%rc = %(Socket):OnReset[('label')]
</p>
===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th>
<td>Numeric return string, which is to contain 0 (success) or a negative integer (see <var class="term">label</var>, below).
</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>label</th>
<td>The label in the program to which to jump to for <var>ONRESET</var> handling. If <var class="term">label</var> is the null string or all blanks, any existing <var>ONRESET</var> label in the current scope is cleared, and <var>OnReset</var> returns: <ul> <li>-3, if <var>OnReset</var> is issued from an <var>ON</var> unit <li>-1, otherwise </ul>

</td></tr></table>
==Usage notes==
<ul>
<li>If <var class="term">label</var> is a valid label
and the <var>OnReset</var> function call is successful, any existing <var>ONRESET</var> label
definition in the current scope is replaced, and <var>OnReset</var> returns 0.
<li>If the <var>OnReset</var> call fails to clear or to set the <var>ONRESET</var> label, the request is cancelled.
<var>OnReset</var> can fail for the following reasons:
<ul>
<li><var class="term">label</var> is not found in the current scope.
<li><var class="term">label</var> is a subroutine.
<li><var>OnReset</var> is invoked from an <var>ON</var> unit, and <var class="term">label</var> is neither the
null string nor all blank.
<li><var class="term">label</var> is in a loop, <var>ON</var> unit, or simple subroutine.
</ul>
<li><var>OnReset</var> is not affected by any <var>ONRESET</var> setting.
<li>A request may have multiple <var>ONRESET</var> labels set: as many as one for each
scope (the outer level of a request is a scope, as is each complex subroutine).
As described in [[Janus Sockets User Language coding considerations#Handling connection errors and RESET sockets|"Handling connection errors and RESET sockets"]],
a jump to an <var>ONRESET</var> label is attempted if both of these are true:
<ul>
<li>A <var>RESET</var> socket is
encountered during a <var class="product">Janus Sockets</var> operation
<li>The socket's <var>ONRESET</var> setting
is <code>LABEL</code> (or <code>LABELC</code>, if the operation requires an <var>OPEN</var> socket)
</ul>
<li>An attempted jump to a label is successful if there is an <var>ONRESET</var> label
within the current or an invoking scope of the <var class="product">User Language</var> request
that encountered the <var>RESET</var> socket.
If there is no such label, the <var class="product">User Language</var> request is cancelled.
<li>Using <var>OnReset</var> to set an <var>ONRESET</var> handler reduces the
amount of return code checking the application has to do on each method call.
</ul>

==Example==

As a result of the <var>OnReset</var> code in the following example, encountering
a <var>RESET</var> socket will print a set of error messages that provide the
failing operation, return code, and socket
identifier before terminating evaluation:
<p class="code">Call %(Socket):OnReset('KABOOM')
...

KABOOM:
%c = %(Socket):Errinfo('CODE')
%s = %(Socket):Errinfo('SOCKNUM')
%f = %(Socket):Errinfo('FUN')
Print 'The connection was unexpectedly lost.'
Print 'The last sockets error operation was:'
Print 'Function: ' with %f
Print 'Return code: ' with %c
Print 'Socket: ' with %s
Stop
</p>

OnReset (Socket function) - Revision history

JALWiccan: Automatically generated page update

JAL2 at 20:55, 20 January 2012

JAL2: /* Syntax terms */

JAL2: /* Syntax terms */

JAL2 at 23:10, 14 November 2011

JAL2: /* Syntax terms */

Admin: 1 revision

198.242.244.47: Created page with " OnReset function OnReset is a member of the [[..."

198.242.244.47: Created page with "
OnReset function
`OnReset` is a member of the `[[..."`