JALWiccan: Automatically generated page update

2018-09-21T00:00:36Z

Automatically generated page update

← Older revision		Revision as of 00:00, 21 September 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_SendLn}}		{{DISPLAYTITLE:$Sock_SendLn}}
	<span class="pageSubtitle">Send string followed by LINEND</span>		<span class="pageSubtitle">Send string followed by LINEND</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_SendLn</var> is the <var>[[SendWithLineEnd (Socket function)\|SendWithLineEnd]]</var> method.</p>		methods. The OO equivalent for <var>$Sock_SendLn</var> is the <var>[[SendWithLineEnd (Socket function)\|SendWithLineEnd]]</var> method.</p>

JAL at 21:54, 23 July 2013

2013-07-23T21:54:42Z

← Older revision		Revision as of 21:54, 23 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Send string followed by LINEND</span>		<span class="pageSubtitle">Send string followed by LINEND</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_SendLn</var> is the <var>[[SendWithLineEnd (Socket function)\|SendWithLineEnd]]</var> method.</p>

	<var>$Sock_SendLn</var> sends an argument string and the untranslated <var>LINEND</var> string		<var>$Sock_SendLn</var> sends an argument string and the untranslated <var>LINEND</var> string

JALWiccan: Automatically generated page update

2013-07-19T18:59:27Z

Automatically generated page update

← Older revision		Revision as of 18:59, 19 July 2013
Line 1:		Line 1:
	{{DISPLAYTITLE:$Sock_SendLn}}		{{DISPLAYTITLE:$Sock_SendLn}}
	<span class="pageSubtitle">Send string followed by LINEND</span>		<span class="pageSubtitle">Send string followed by LINEND</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 01:55, 20 January 2012

2012-01-20T01:55:03Z

New page

{{DISPLAYTITLE:$Sock_SendLn}}
Send string followed by LINEND
Most Sirius $functions have been deprecated in favor of Object Oriented
methods. There is currently no direct OO equivalent for this $function.

<var>$Sock_SendLn</var> sends an argument string and the untranslated <var>LINEND</var> string
over a <var class="product">Janus Sockets</var> connection.

It is also a [[Notation conventions for methods#Callable functions|callable]] function.

==Syntax==
[%rc =] = $Sock_SendLn(sockNum, string, [opts]) 

===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th>
<td>A numeric error code (described further [[#$Sock_Send return codes|below]]), or if the operation could not be performed as requested, a 0 value. For more details, see [[#$Sock_RecvPrs return values|"$Sock_RecvPrs return values"]]. </td></tr><tr><th>sockNum</th>
<td>The socket number. </td></tr>
<tr><th>string</th>
<td>The string to send. <var class="product">Model 204</var> limits this to a length of 255 bytes. </td></tr>
<tr><th>opts</th>
<td>This optional argument is an option string, which can contain any of the following:
<table class="syntaxTable">

<tr><th><var>BINARY</var> </th>
<td>Indicates that regardless of the socket's <var>[[BINARY (JANUS DEFINE parameter)|BINARY]]</var> or <var>[[CHAR (JANUS DEFINE parameter)|CHAR]]</var> parameter, data '''is not translated''' when sent. The argument can be the result of a previous translation using <var>[[$Sock_Tran_Out]]</var>.</td></tr>

<tr><th><var>CHAR</var> </th>
<td>Indicates that regardless of the socket's <var>BINARY</var> or <var>CHAR</var> parameter, data '''is translated''' when sent. The translation is specified by the output table defined by the socket's <var>[[XTAB (JANUS DEFINE parameter)|XTAB]]</var> parameter. </td></tr>

<tr><th><var>FIN</var> </th>
<td>Indicates that after the <var class="term">string</var> argument and the <var>LINEND</var> string are sent, no more data will be sent on the socket. This transmits the <code>FIN</code> indication to the remote partner. See [[Janus Sockets User Language coding considerations#Socket states: OPEN, RESET, FIN indicator|"Socket states: OPEN, RESET, FIN indicator"]] for a discussion of the <var>FIN</var> indicator.
 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 <var>PUSH</var> is '''not''' necessary if: 
<ul>
<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 functions (<var>$Sock_Recv</var> and <var>$Sock_RecvPrs</var>) always do a push before receiving.
</ul></td></tr>
<tr><th nowrap><var>LINEND</var> hexstr</th>
<td>The string whose hexadecimal representation is <var class="term">hexstr</var> is used rather than the current <var>[[LINEND (JANUS DEFINE parameter)|LINEND]]</var> parameter of the socket. </td></tr>
</table>
</td></tr></table>

==Usage notes==
<ul>
<li>Whether it is set on the port definition, via <var>[[$Sock_Set]]</var>, or as an argument on the <var>$Sock_SendLn</var> function, <var>LINEND</var> must not be <var>NONE</var> when using <var>$Sock_SendLn</var>.
<li>These are the <var>$Sock_SendLn</var> return codes:
<ul>
<li>0, if the function completes successfully.
<li>-1, if the socket is not open and <var>ONRESET CONTINUE</var> is in effect for the socket.
</ul> </ul>

==Example==
The following example uses a combination of <var>$Sock_Send</var> and <var>$Sock_SendLn</var>.
%domain = 'www.sirius-software.com'
%page = 'main.html'
%socket = $Sock_Conn('TEST', %domain)
%s = $Sock_Set(%socket, 'LINEND', '0D0A')
%rc = $Sock_Send(%socket, 'GET /')
%rc = $Sock_Send(%socket, %page)
%rc = $Sock_SendLn(%socket, ' HTTP/1.0')
%rc = $Sock_SendLn(%socket, '')

In this example, <var>$Sock_Set</var> is used to specify a line-end string of hexadecimal '0D0A'. Then, a few lines are sent for which the protocol does not require line-end delimiters: the <code>GET /</code> and the name of the HTML page defined in <code>%page</code>. Then the HTTP specification is sent with a line-delimiter via the <var>$Sock_SendLn</var> function.

This example highlights the fact that the programmer needs to know the requirements of the communication protocol they are using before they know the appropriate function to use in sending strings to the socket.

[[Category: Janus Sockets $functions]]

$Sock SendLn - Revision history

JALWiccan: Automatically generated page update

JAL at 21:54, 23 July 2013

JALWiccan: Automatically generated page update

Admin: 1 revision

JAL at 01:55, 20 January 2012