ReceiveAsynchronous (Socket function) - Revision history

JAL2 at 16:14, 11 June 2012

2012-06-11T16:14:03Z

← Older revision		Revision as of 16:14, 11 June 2012
Line 2:		Line 2:

	Unlike the <var>[[Receive (Socket function)\|Receive]]</var> and		Unlike the <var>[[Receive (Socket function)\|Receive]]</var> and
	<var>[[ReceiveAndParse (Socket function)\|ReceiveAndParse]]</var> methods, if <var>ReceiveAsynchronous</var> receives fewer than the requested number of bytes, it will return, either immediately or after a timeout.		<var>[[ReceiveAndParse (Socket function)\|ReceiveAndParse]]</var> methods, if <var>ReceiveAsynchronous</var> receives fewer than the requested number of bytes, it will return, either immediately or after a timeout, according to your specification.

	==Syntax==		==Syntax==

JAL2: /* Usage notes */

2012-06-11T15:56:20Z

Usage notes

← Older revision		Revision as of 15:56, 11 June 2012
Line 54:		Line 54:
	</ul>		</ul>

	A returned o is not ambiguous with the <var>Receive</var> and		A returned 0 is not ambiguous with the <var>Receive</var> and
	<var>ReceiveAndParse</var> methods, because they only return a 0 when a FIN was received. But if a 0 is returned from <var>ReceiveAsynchronous</var>, you must determine if it is		<var>ReceiveAndParse</var> methods, because they only return a 0 when a FIN was received. But if a 0 is returned from <var>ReceiveAsynchronous</var>, you must determine if it is
	caused by a FIN or not: If <var>ReceiveAsynchronous</var> returns a 0 because a FIN was received, and you call it		caused by a FIN or not: If <var>ReceiveAsynchronous</var> returns a 0 because a FIN was received, and you call it

JAL2 at 22:01, 8 June 2012

2012-06-08T22:01:31Z

← Older revision		Revision as of 22:01, 8 June 2012
Line 1:		Line 1:
	{{Template:Socket:ReceiveAsynchronous subtitle}}		{{Template:Socket:ReceiveAsynchronous subtitle}}

			Unlike the <var>[[Receive (Socket function)\|Receive]]</var> and
			<var>[[ReceiveAndParse (Socket function)\|ReceiveAndParse]]</var> methods, if <var>ReceiveAsynchronous</var> receives fewer than the requested number of bytes, it will return, either immediately or after a timeout.

	==Syntax==		==Syntax==
Line 51:		Line 54:
	</ul>		</ul>

	A returned o is not ambiguous with the <var>[[Receive ~~(Socket function)\|Receive]]~~</var> and		A returned o is not ambiguous with the <var>Receive</var> and
	<var>~~[[ReceiveAndParse (Socket function)\|~~ReceiveAndParse]]</var> methods, because they only return a 0 when a FIN was received. But if a 0 is returned from <var>ReceiveAsynchronous</var>, you must determine if it is		<var>ReceiveAndParse</var> methods, because they only return a 0 when a FIN was received. But if a 0 is returned from <var>ReceiveAsynchronous</var>, you must determine if it is
	caused by a FIN or not: If <var>ReceiveAsynchronous</var> returns a 0 because a FIN was received, and you call it		caused by a FIN or not: If <var>ReceiveAsynchronous</var> returns a 0 because a FIN was received, and you call it
	(or <var>Receive</var>) again, you will get a request cancellation. So when <var>ReceiveAsynchronous</var>		(or <var>Receive</var>) again, you will get a request cancellation. So when <var>ReceiveAsynchronous</var>

JAL2: /* Syntax terms */

2012-06-08T21:54:06Z

Syntax terms

← Older revision		Revision as of 21:54, 8 June 2012
Line 6:		Line 6:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%BytesReceived</th><td>number</td></tr>		<tr><th>%BytesReceived</th>
			<td>A numeric string to contain the count of the number of bytes received, or to contain 0, if the operation cannot be performed.</td></tr>

	<tr><th>socket</th>		<tr><th>socket</th>
	<td>A variable or an expression that is a reference to a <var>Socket</var> object.</td></tr>		<td>A variable or an expression that is a reference to a <var>Socket</var> object.</td></tr>

	<tr><th><var>Target</var></th>		<tr><th><var>Target</var></th>
	<td>This [[Notation conventions for methods#Named parameters\|name allowed]] parameter is a %variable or an <var>IMAGE</var> item that is the target of the receive operation. It is referred to as the "receive target." Since you may request that some bytes from the socket stream be discarded, the length of the string stored in this target may be less than the <var class="term">%BytesReceived</var> value.		<td>This [[Notation conventions for methods#Named parameters\|name allowed]] parameter is a %variable or an <var>IMAGE</var> item that is the target of the receive operation. It is referred to as the "receive target." Since you may request that some bytes from the socket stream be discarded, the length of the string stored in this target may be less than the <var class="term">%BytesReceived</var> value.

JAL2 at 21:52, 8 June 2012

2012-06-08T21:52:58Z

← Older revision		Revision as of 21:52, 8 June 2012
Line 15:		Line 15:
	<tr><th><var>MaxBytes</var></th>		<tr><th><var>MaxBytes</var></th>
	<td>This optional, name allowed, parameter is the maximum number of bytes of data to receive, '''less''' the length of the separator string. This optional argument defaults to 0, which means limit the received data (less separator) to the declared length of the receive target.		<td>This optional, name allowed, parameter is the maximum number of bytes of data to receive, '''less''' the length of the separator string. This optional argument defaults to 0, which means limit the received data (less separator) to the declared length of the receive target.
	If <var ~~class="term"~~>~~maxrecvp~~</var> is 0 and <var ~~class="term"~~>~~target~~</var> is a <var>Longstring</var>, the received data is limited to 2,147,483,647 bytes. The <var>MaxBytes</var> argument value must not exceed 2,147,483,647.		<p>If the <var>MaxBytes</var> argument value is 0, and the <var>Target</var> argument is a <var>Longstring</var>, the received data is limited to 2,147,483,647 bytes. The <var>MaxBytes</var> argument value must not exceed 2,147,483,647.
	<var>MaxBytes</var> may have the special value <code>-1</code> to indicate there is no limit to the number of bytes received.		<var>MaxBytes</var> may have the special value <code>-1</code> to indicate there is no limit to the number of bytes received.
	</td></tr>		</p></td></tr>

	<tr><th><var>Options</var></th>		<tr><th><var>Options</var></th>
Line 26:		Line 26:
	<tr><th><var>CHAR</var> </th><td>Regardless of the socket's <var>BINARY</var> or <var>CHAR</var> parameter, data '''is translated''' when saved in the receive target. The translation is specified by the input table defined by the socket's <var>[[XTAB (JANUS DEFINE parameter)\|XTAB]]</var> port parameter.		<tr><th><var>CHAR</var> </th><td>Regardless of the socket's <var>BINARY</var> or <var>CHAR</var> parameter, data '''is translated''' when saved in the receive target. The translation is specified by the input table defined by the socket's <var>[[XTAB (JANUS DEFINE parameter)\|XTAB]]</var> port parameter.
	</td></tr>		</td></tr>
	<tr><th>PRSTOK [AMBIG\|]<i>hexstr</i>[\|<i>hexstr</i>]...		<tr><th nowrap><var>PRSTOK [AMBIG\|]</var>hexstr<var>[\|</var>hexstr<var>]...</var>
	</th><td>A set of parse tokens that override the current parse tokens on the socket.		</th><td>A set of parse tokens that override the current parse tokens on the socket.

	Whether it is set on the port definition or by the <var>[[Set (Socket function)\|Set]]</var> or <var>ReceiveAndParse</var> methods, <var>PRSTOK</var> must '''not''' be <code>NONE</code> or <var>ReceiveAndParse</var> will fail.		Whether it is set on the port definition or by the <var>[[Set (Socket function)\|Set]]</var> or <var>ReceiveAndParse</var> methods, <var>PRSTOK</var> must '''not''' be <code>NONE</code>, or <var>ReceiveAndParse</var> will fail.
	</td></tr></table>		</td></tr></table>

	<tr><th><var>Wait</var></th>		<tr><th><var>Wait</var></th>
	<td><var>Boolean</var> value		<td>This name allowed, optional, <var>[[Boolean enumeration\|Boolean]]</var> value indicates whether the method should wait until the timeout time before returning, if <var>MaxBytes</var> bytes are not immediately available.
			<p>
	~~that~~ indicates whether it should wait the timeout time before returning if MaxBytes		If <code>Wait=True</code> and the request for <var>MaxBytes</var> times out, the conection is not closed, and some number of bytes between 0 and <code>MaxBytes-1</code> is returned. If <code>Wait=False</code>, <var>ReceiveAsynchronous</var> returns immediately with whatever number of input bytes are available. </p></td></tr>
	bytes ~~weren't~~ immediately available. ~~Note that if~~ Wait=~~true~~ and the request for MaxBytes
	times out, the conection is not closed and some number of bytes between 0 and MaxBytes-1
	~~would be~~ returned. If Wait=False, ReceiveAsynchronous ~~will returned~~ immediately with
	whatever number of input bytes are available.
	</td></tr>
	</table>		</table>

Line 53:		Line 48:
	</ul>		</ul>

	A returned o is not ambiguous with the <var>Receive</var> and		A returned o is not ambiguous with the <var>[[Receive (Socket function)\|Receive]]</var> and
	<var>ReceiveAndParse</var> methods, because they only return a 0 when a FIN was received.		<var>[[ReceiveAndParse (Socket function)\|ReceiveAndParse]]</var> methods, because they only return a 0 when a FIN was received. But if a 0 is returned from <var>ReceiveAsynchronous</var>, you must determine if it is
	But if a 0 is returned from <var>ReceiveAsynchronous</var>, you must determine if it is
	caused by a FIN or not: If <var>ReceiveAsynchronous</var> returns a 0 because a FIN was received, and you call it		caused by a FIN or not: If <var>ReceiveAsynchronous</var> returns a 0 because a FIN was received, and you call it
	(or <var>Receive</var>) again, you will get a request cancellation. So when <var>ReceiveAsynchronous</var>		(or <var>Receive</var>) again, you will get a request cancellation. So when <var>ReceiveAsynchronous</var>

JAL2 at 21:40, 8 June 2012

2012-06-08T21:40:15Z

@@ Line 44: / Line 44: @@
 ==Usage notes==
-==Examples==
+<ul>
 ==See also==

JAL2: /* See also */

2012-06-08T21:16:53Z

JAL2: /* Syntax terms */

2012-06-08T20:09:34Z

Syntax terms

@@ Line 10: / Line 10: @@
 <td>A variable or an expression that is a reference to a <var>Socket</var> object.</td></tr>
 <tr><th><var>Target</var></th>
-<td>string</td></tr>
+<td>This [[Notation conventions for methods#Named parameters|name allowed]] parameter is a %variable or an <var>IMAGE</var> item that is the target of the receive operation. It is referred to as the "receive target." Since you may request that some bytes from the socket stream be discarded, the length of the string stored in this target may be less than the <var class="term">%BytesReceived</var> value.
 <tr><th><var>MaxBytes</var></th>
-<td>number</td></tr>
+<td>This optional, name allowed, parameter is the maximum number of bytes of data to receive, '''less''' the length of the separator string. This optional argument defaults to 0, which means limit the received data (less separator) to the declared length of the receive target.
 <tr><th><var>Options</var></th>
-<td>string</td></tr>
+<td>This optional, name allowed, parameter is an option string, which can contain either of the following:
 <tr><th><var>Wait</var></th>
-<td><var>Boolean</var> value</td></tr>
+<td><var>Boolean</var> value
 </table>

JAL2: /* Syntax terms */

2011-11-15T02:03:00Z

Syntax terms

← Older revision		Revision as of 02:03, 15 November 2011
Line 8:		Line 8:
	<tr><th>%BytesReceived</th><td>number</td></tr>		<tr><th>%BytesReceived</th><td>number</td></tr>
	<tr><th>socket</th>		<tr><th>socket</th>
	<td>Socket object</td></tr>		<td>A variable or an expression that is a reference to a <var>Socket</var> object.</td></tr>
	<tr><th><var>Target</var></th>		<tr><th><var>Target</var></th>
	<td>string</td></tr>		<td>string</td></tr>
Line 18:		Line 18:
	<td><var>Boolean</var> value</td></tr>		<td><var>Boolean</var> value</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	==Examples==		==Examples==

JAL2 at 23:13, 14 November 2011

2011-11-14T23:13:16Z

← Older revision		Revision as of 23:13, 14 November 2011
Line 3:		Line 3:
	==Syntax==		==Syntax==
	{{Template:Socket:ReceiveAsynchronous syntax}}		{{Template:Socket:ReceiveAsynchronous syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 19:		Line 20:
	==Usage notes==		==Usage notes==
	==Examples==		==Examples==

	==See also==		==See also==

	{{Template:Socket:ReceiveAsynchronous footer}}		{{Template:Socket:ReceiveAsynchronous footer}}

← Older revision		Revision as of 21:16, 8 June 2012
Line 47:		Line 47:

	==See also==		==See also==
			<ul>
			<li><var>[[Receive (Socket function)\|Receive]]</var>
			<li><var>[[ReceiveAndParse (Socket function)\|ReceiveAndParse]]</var>
			</ul>
	{{Template:Socket:ReceiveAsynchronous footer}}		{{Template:Socket:ReceiveAsynchronous footer}}