SendWithLineEnd (Socket function) - Revision history

JAL: link repair

2014-12-17T21:42:50Z

link repair

← Older revision		Revision as of 21:42, 17 December 2014
Line 8:		Line 8:

	The <var>SendWithLineEnd</var> function, which may be invoked with a <var>Call</var> statement,		The <var>SendWithLineEnd</var> function, which may be invoked with a <var>Call</var> statement,
	has an effect similar to <var>[[$~~Sock_Sendln~~]]</var>.		has an effect similar to <var>[[$Sock_SendLn]]</var>.

	==Syntax==		==Syntax==

Dme at 14:41, 11 November 2012

2012-11-11T14:41:34Z

← Older revision		Revision as of 14:41, 11 November 2012
Line 67:		Line 67:
	==Examples==		==Examples==
	The following example uses a combination of <var>Send</var> and <var>SendWithLineEnd</var>.		The following example uses a combination of <var>Send</var> and <var>SendWithLineEnd</var>.
	<p class="code"> ...		<p class="code">...
	%domain = 'www.sirius-software.com'		%domain = 'www.sirius-software.com'
	%page = 'main.html'		%page = 'main.html'
Line 77:		Line 77:
	%rc = %socket:SendWithLineEnd(' HTTP/1.0')		%rc = %socket:SendWithLineEnd(' HTTP/1.0')
	%rc = %socket:SendWithLineEnd('')		%rc = %socket:SendWithLineEnd('')
	...		...
	</p>		</p>
	In this example, the <var>Set</var> method specifies a line-end string of		In this example, the <var>Set</var> method specifies a line-end string of

JAL2 at 19:08, 11 June 2012

2012-06-11T19:08:11Z

← Older revision		Revision as of 19:08, 11 June 2012
Line 23:		Line 23:
	<td>The socket is not open, and <code>ONRESET CONTINUE</code> is in effect for the socket. </td></tr>		<td>The socket is not open, and <code>ONRESET CONTINUE</code> is in effect for the socket. </td></tr>
	</table></td></tr>		</table></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>string</th>		<tr><th>string</th>
	<td>The string to send.</td></tr>		<td>The string to send.</td></tr>

	<tr><th><var>Options</var></th>		<tr><th><var>Options</var></th>
	<td>This optional, [[Notation conventions for methods#Named parameters\|name allowed]], argument is an option string that may contain any of the following:		<td>This optional, [[Notation conventions for methods#Named parameters\|name allowed]], argument is an option string that may contain any of the following:
	<table class="syntaxTable">		<table class="syntaxTable">

	<tr><th><var>BINARY</var> </th>		<tr><th><var>BINARY</var> </th>
	<td>Regardless of whether the <var>BINARY</var> or <var>CHAR</var> parameter is in effect for the socket's port, data '''is not translated''' when sent. The argument can be the result of a previous translation using the <var>[[TranOut (Socket function)\|TranOut]]</var></td></tr>		<td>Regardless of whether the <var>BINARY</var> or <var>CHAR</var> parameter is in effect for the socket's port, data '''is not translated''' when sent. The argument can be the result of a previous translation using the <var>[[TranOut (Socket function)\|TranOut]]</var></td></tr>

	<tr><th><var>CHAR</var> </th>		<tr><th><var>CHAR</var> </th>
	<td>Regardless of whether the <var>BINARY</var> or <var>CHAR</var> parameter is in effect for the socket's port, data '''is translated''' when sent. The translation is specified by the output table defined by the socket's <var>XTAB</var> paramete</td></tr>		<td>Regardless of whether the <var>BINARY</var> or <var>CHAR</var> parameter is in effect for the socket's port, data '''is translated''' when sent. The translation is specified by the output table defined by the socket's <var>XTAB</var> paramete</td></tr>

	<tr><th><var>FIN</var> </th>		<tr><th><var>FIN</var> </th>
	<td>After <var class="term">string</var> is sent, no more data will be sent on the socket. This transmits the <code>FIN</code> indication to the remote partner.		<td>After <var class="term">string</var> is sent, no more data will be sent on the socket. This transmits the <code>FIN</code> indication to the remote partner.
Line 40:		Line 45:
	<td>Ensures that the data being sent on the socket is immediately sent to the receiver. Normally, data to be sent is buffered and may not be sent immediately.		<td>Ensures that the data being sent on the socket is immediately sent to the receiver. Normally, data to be sent is buffered and may not be sent immediately.

	Using PUSH is '''not''' necessary if:		Using <var>PUSH</var> is '''not''' necessary if:
	<ul>		<ul>
	<li>You are specifying FIN, since a push operation is implied by FIN.		<li>You are specifying <var>FIN</var>, since a push operation is implied by <var>FIN</var>.
	<li>You are alternating sends and receives on a socket, since receive-processing methods (<var>Receive</var> and <var>ReceiveAndParse</var>) always do a push before receiving.		<li>You are alternating sends and receives on a socket, since receive-processing methods (<var>Receive</var> and <var>ReceiveAndParse</var>) always do a push before receiving.
	</ul></td></tr>		</ul></td></tr>
	<tr><th><var>LINEND</var> <i><b>hexstr</b></i></th>
			<tr><th nowrap><var>LINEND</var> <i><b>hexstr</b></i></th>
	<td>The line-end string to send. The string whose hexadecimal representation is <var class="term">hexstr</var> is used rather than the current <var>LINEND</var> parameter setting in effect for the socket. For example:		<td>The line-end string to send. The string whose hexadecimal representation is <var class="term">hexstr</var> is used rather than the current <var>LINEND</var> parameter setting in effect for the socket. For example:
	<p class="code">%sock:SendWithLineEnd('GO', 'LINEND 07')		<p class="code">%sock:SendWithLineEnd('GO', 'LINEND 07')
Line 53:		Line 59:

	==Usage notes==		==Usage notes==
			<ul>
	Whether it's set on the port definition, via the <var>[[Set (Socket function)\|Set]]</var> method, or as an argument		<li>Whether it's set on the port definition, via the <var>[[Set (Socket function)\|Set]]</var> method, or as an argument
	on the <var>SendWithLineEnd</var> function, <var>LINEND</var> must not be <code>NONE</code>		on the <var>SendWithLineEnd</var> function, <var>LINEND</var> must not be <code>NONE</code>
	when using <var>SendWithLineEnd</var>.		when using <var>SendWithLineEnd</var>.
			</ul>

	==~~Example~~==		==Examples==

	The following example uses a combination of <var>Send</var> and <var>SendWithLineEnd</var>.		The following example uses a combination of <var>Send</var> and <var>SendWithLineEnd</var>.
	<p class="code"> ...		<p class="code"> ...

JAL2: /* Syntax terms */

2012-06-07T22:20:28Z

Syntax terms

← Older revision		Revision as of 22:20, 7 June 2012
Line 27:		Line 27:
	<tr><th>string</th>		<tr><th>string</th>
	<td>The string to send.</td></tr>		<td>The string to send.</td></tr>
	<tr><th>~~opt~~</th>		<tr><th><var>Options</var></th>
	<td>This optional argument is an option string that may contain any of the following:		<td>This optional, [[Notation conventions for methods#Named parameters\|name allowed]], argument is an option string that may contain any of the following:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th><var>BINARY</var> </th>		<tr><th><var>BINARY</var> </th>

JAL2: /* Syntax terms */

2011-11-15T02:04:36Z

Syntax terms

← Older revision		Revision as of 02:04, 15 November 2011
Line 15:		Line 15:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%rc</th>		<tr><th>%number</th>
	<td>If specified, this is a numeric variable to contain the returned indicator of success of the function. The return value is either of these:		<td>If specified, this is a numeric variable to contain the returned indicator of success of the function. The return value is either of these:
	<table>		<table>

JALWiccan: 1 revision

2011-11-15T01:23:46Z

1 revision

← Older revision	Revision as of 01:23, 15 November 2011
(No difference)

JAL2 at 01:23, 15 November 2011

2011-11-15T01:23:45Z

← Older revision		Revision as of 01:23, 15 November 2011
Line 23:		Line 23:
	<td>The socket is not open, and <code>ONRESET CONTINUE</code> is in effect for the socket. </td></tr>		<td>The socket is not open, and <code>ONRESET CONTINUE</code> is in effect for the socket. </td></tr>
	</table></td></tr>		</table></td></tr>
	<tr><th>~~%socko~~</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>string</th>		<tr><th>string</th>

JAL2 at 23:15, 14 November 2011

2011-11-14T23:15:37Z

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

	This method sends a string and an untranslated line-end string		This method sends a string and an untranslated line-end string
Line 15:		Line 11:

	==Syntax==		==Syntax==
	~~<p class="syntax">[%rc =] %socko~~:SendWithLineEnd~~(string, [opt])~~		{{Template:Socket:SendWithLineEnd syntax}}
	~~</p>~~

	===Syntax terms===		===Syntax terms===
Line 89:		Line 84:
	the requirements of the communication protocol before		the requirements of the communication protocol before
	they know the appropriate method to use to send strings to the socket.		they know the appropriate method to use to send strings to the socket.

			{{Template:Socket:SendWithLineEnd footer}}

Admin: 1 revision

2011-11-08T21:35:42Z

1 revision

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

JAL at 21:00, 8 November 2011

2011-11-08T21:00:04Z

New page

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

This method sends a string and an untranslated line-end string
over a <var class="product">Janus Sockets</var> connection.
The [[LINEND|line-end]] string may be set on the port definition
via the <var>[[Set (Socket function)|Set]]</var> method or as an argument
on the <var>SendWithLineEnd</var> function.

The <var>SendWithLineEnd</var> function, which may be invoked with a <var>Call</var> statement,
has an effect similar to <var>[[$Sock_Sendln]]</var>.

==Syntax==
<p class="syntax">[%rc =] %socko:SendWithLineEnd(string, [opt])
</p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th>
<td>If specified, this is a numeric variable to contain the returned indicator of success of the function. The return value is either of these:
<table>
<tr><th>0 </th>
<td>The function completed successfully.</td></tr>
<tr><th>-1</th>
<td>The socket is not open, and <code>ONRESET CONTINUE</code> is in effect for the socket. </td></tr>
</table></td></tr>
<tr><th>%socko</th>
<td>A variable or an expression that is a reference to a <var>Socket</var> object.</td></tr>
<tr><th>string</th>
<td>The string to send.</td></tr>
<tr><th>opt</th>
<td>This optional argument is an option string that may contain any of the following:
<table class="syntaxTable">
<tr><th><var>BINARY</var> </th>
<td>Regardless of whether the <var>BINARY</var> or <var>CHAR</var> parameter is in effect for the socket's port, data '''is not translated''' when sent. The argument can be the result of a previous translation using the <var>[[TranOut (Socket function)|TranOut]]</var></td></tr>
<tr><th><var>CHAR</var> </th>
<td>Regardless of whether the <var>BINARY</var> or <var>CHAR</var> parameter is in effect for the socket's port, data '''is translated''' when sent. The translation is specified by the output table defined by the socket's <var>XTAB</var> paramete</td></tr>
<tr><th><var>FIN</var> </th>
<td>After <var class="term">string</var> is sent, no more data will be sent on the socket. This transmits the <code>FIN</code> indication to the remote partner.
Note that when <code>FIN</code> is sent, print capturing is automatically turned <var>OFF</var> for the socket.</td></tr>
<tr><th><var>PUSH</var></th>
<td>Ensures that the data being sent on the socket is immediately sent to the receiver. Normally, data to be sent is buffered and may not be sent immediately.

Using PUSH is '''not''' necessary if:
<ul>
<li>You are specifying FIN, since a push operation is implied by FIN.
<li>You are alternating sends and receives on a socket, since receive-processing methods (<var>Receive</var> and <var>ReceiveAndParse</var>) always do a push before receiving.
</ul></td></tr>
<tr><th><var>LINEND</var> <i><b>hexstr</b></i></th>
<td>The line-end string to send. The string whose hexadecimal representation is <var class="term">hexstr</var> is used rather than the current <var>LINEND</var> parameter setting in effect for the socket. For example:
<p class="code">%sock:SendWithLineEnd('GO', 'LINEND 07')
</p>
</td></tr></table>
</td></tr></table>

==Usage notes==

Whether it's set on the port definition, via the <var>[[Set (Socket function)|Set]]</var> method, or as an argument
on the <var>SendWithLineEnd</var> function, <var>LINEND</var> must not be <code>NONE</code>
when using <var>SendWithLineEnd</var>.

==Example==

The following example uses a combination of <var>Send</var> and <var>SendWithLineEnd</var>.
<p class="code"> ...
%domain = 'www.sirius-software.com'
%page = 'main.html'
%socket is Object <var>Socket</var>
%socket = New('TEST', %domain)
%socket:Set('LINEND', '0D0A')
%socket:Send('GET /')
%rc = %socket:Send(%page)
%rc = %socket:SendWithLineEnd(' HTTP/1.0')
%rc = %socket:SendWithLineEnd('')
...
</p>
In this example, the <var>Set</var> method specifies a line-end string of
hexadecimal '0D0A'.
Then, lines are sent for which the protocol does not require
line-end delimiters: the "GET," and the HTML page defined
in <code>%page</code>.
Then the <var>SendWithLineEnd</var> function sends
the HTTP specification with a line-delimiter.

This example highlights the fact that the programmer needs to know
the requirements of the communication protocol before
they know the appropriate method to use to send strings to the socket.