View source for $Sock Info

{{DISPLAYTITLE:$Sock_Info}}
<span class="pageSubtitle">Get info about a socket</span>
<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented
methods. The OO equivalent for <var>$Sock_Info</var> is the <var>[[Info (Socket function)|Info]]</var> method.</p>

<var>$Sock_info</var> retrieves socket information.

==Syntax==
<p class="syntax"><span class="term">%info</span><span class="literal"> = $Sock_Info(</span><span class="term">socket</span><span class="literal">,</span> <span class="term">infoType</span><span class="literal">)</span>  </p>

===Syntax terms===
<table class="syntaxTable">
<tr><th>%info</th>
<td>A string that contains the requested information. </td></tr> 
<tr><th>socket</th> 
<td>A string that is the socket identifier. 
<tr><th>infoType</th> 
<td>One of the following string indicators of the information to be retrieved about the socket: 

<table class="syntaxTable">
<tr><th><i>Value</i></th> 
<th><i>Description</i></th></tr> 
<tr><th><var>CAPTURE</var></th> 
<td>Retrieve current print capture setting of socket (see <var>[[$Sock_Capture]]</var>). The socket need not be <code>OPEN</code>. </td></tr> 
<tr><th><var>REMOTE</var></th> 
<td>Retrieve dotted IP address of remote host, followed by blank and remote port number. The socket must be <code>OPEN</code>; if it is not, the string "RESET" is returned. </td></tr> 
<tr><th><var>STAT</var></th> 
<td>Retrieve socket state. The socket need not be <code>OPEN</code>. The returned value will be one of the following: 
<dl> 
<dt>CONN <dd>Socket <code>OPEN</code> and enabled for sending in both directions 
<dt>FINR <dd>Socket <code>OPEN</code>, remote stopped sending, local enabled for sending ("FIN received but not sent") 
<dt>FINS <dd>Socket <code>OPEN</code>, local stopped sending, remote enabled for sending ("FIN sent but not received") <dt>FINBOTH <dd>Socket <code>OPEN</code>, local and remote stopped sending ("FIN sent and received") 
<dt>RESET <dd>Socket is <code>RESET</code> (no longer connected) 
</dl> 
<br> 
<b>Note:</b> Since the status of <code>OPEN</code> sockets may include several more status types in future releases, test for <code>OPEN</code> sockets by testing for the string "RESET": 
<p class="code">If $sock_info(%sk, 'STATUS') Ne 'RESET' ... </p> </td></tr> 
<tr><th>opt</th> 
<td>Any of the strings that may be passed as the second argument to <var>$Sock_Set</var> (for example, <var>CHAR</var> or <var>PRSTOK</var>). For some of these, the socket must be <code>OPEN</code>; if not, the string "RESET" is returned. To view the arguments that require an <code>OPEN</code> socket, see <var>[[$Sock_Set]]</var>. </td></tr>
</table> 
The <var>$Sock_Info</var> function returns either the requested value or, as noted above, the string "RESET".
If <var>$Sock_Info</var> is invoked with a socket that is <code>RESET</code>, the results depend on several factors: 
<ul> 
<li>If argument two is <var>ONRESET</var>, the operation is performed normally, and there is no indication of the fact that the socket is RESET. 
<li>Otherwise, if argument two is a keyword which does not require an <code>OPEN</code> socket, and <var>ONRESET CONTINUE</var>, <var>CANCELC</var>, or <var>LABELC</var> is in effect for the socket, the string <code>RESET</code> is returned and the last error information is set. 
<li>Otherwise, if <var>ONRESET CONTINUE</var> is in effect for the socket, the string <code>RESET</code> is returned and the last error information is set. 
<li>Otherwise the request is canceled or the <code>ONRESET</code> label is jumped to, as explained in [[Janus Sockets User Language coding considerations#Handling connection errors and RESET sockets|"Handling connection errors and RESET sockets"]]. </ul>

[[Category: Janus Sockets $functions]]