$Sock Send - Revision history

JALWiccan: Automatically generated page update

2018-09-21T00:00:35Z

Automatically generated page update

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

JAL at 21:52, 23 July 2013

2013-07-23T21:52:42Z

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

	<var>$Sock_Send</var> sends a string over a <var class="product">Janus Sockets</var> connection.		<var>$Sock_Send</var> sends a string over a <var class="product">Janus Sockets</var> connection.

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_Send}}		{{DISPLAYTITLE:$Sock_Send}}
	<span class="pageSubtitle">Send string</span>		<span class="pageSubtitle">Send string</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>

JAL2 at 03:41, 20 January 2012

2012-01-20T03:41:20Z

← Older revision		Revision as of 03:41, 20 January 2012
Line 9:		Line 9:

	==Syntax==		==Syntax==
	<p class="syntax"><span class="squareb">[</span><span class="term">%rc</span><span class="literal"> =</span><span class="squareb">]</span><span class="literal"> $Sock_Send(</span><span class="term">~~sockno~~</span><span class="literal">, </span><span class="term">string</span><span class="literal">, </span><span class="squareb">[</span><span class="term">opts</span><span class="squareb">]</span><span class="literal">)</span> </p>		<p class="syntax"><span class="squareb">[</span><span class="term">%rc</span><span class="literal"> =</span><span class="squareb">]</span><span class="literal"> $Sock_Send(</span><span class="term">sockNum</span><span class="literal">, </span><span class="term">string</span><span class="literal">, </span><span class="squareb">[</span><span class="term">opts</span><span class="squareb">]</span><span class="literal">)</span> </p>

	===Syntax terms===		===Syntax terms===
Line 15:		Line 15:
	<tr><th>%rc</th>		<tr><th>%rc</th>
	<td>A numeric value that is 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>		<td>A numeric value that is 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>~~sockno~~</th>		<tr><th>sockNum</th>
	<td>The socket number. </td></tr>		<td>The socket number. </td></tr>
	<tr><th>string</th>		<tr><th>string</th>

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:43, 20 January 2012

2012-01-20T01:43:19Z

New page

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

<var>$Sock_Send</var> sends a 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_Send(sockno, string, [opts]) 

===Syntax terms===
<table class="syntaxTable">
<tr><th>%rc</th>
<td>A numeric value that is 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>sockno</th>
<td>The socket number. </td></tr>
<tr><th>string</th>
<td>The string to send. </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 in 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 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 <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>
</table>
</td></tr></table>

===$Sock_Send return codes===
<ul>
<li>0, if the function completes successfully.
<li>-1, if the socket is not open and ONRESET CONTINUE is in effect for the socket.
</ul>

If you need to send line-end delimited information, use <var>[[$Sock_SendLn]]</var>.

[[Category: Janus Sockets $functions]]