Janus Sockets $functions - Revision history

JAL at 19:45, 1 August 2014

2014-08-01T19:45:53Z

← Older revision		Revision as of 19:45, 1 August 2014
Line 14:		Line 14:
	used: for example, a socket port must be connected before data is sent using it,		used: for example, a socket port must be connected before data is sent using it,
	and data may not be sent after the <var>FIN</var> indicator is sent.		and data may not be sent after the <var>FIN</var> indicator is sent.
	For more information about <var class="product">Janus Sockets</var> programming, see [[Janus Sockets User Language coding considerations~~\|"Janus Sockets User Language coding considerations"~~]].		For more information about <var class="product">Janus Sockets</var> programming, see [[Janus Sockets User Language coding considerations]].

	Sample programs using $functions are		Sample programs using $functions are
	included in [[Sample Janus Sockets programs~~\|"Sample Janus Sockets programs"~~]] and in the JANUS file		included in [[Sample Janus Sockets programs]] and in the JANUS file
	distributed with this product.		distributed with this product.

Line 23:		Line 23:

	==Janus Sockets $function summary==		==Janus Sockets $function summary==
	The <var class="product">Janus Sockets</var> <var class="product">~~User Language~~</var> $functions for communicating with remote		The <var class="product">Janus Sockets</var> <var class="product">SOUL</var> $functions for communicating with remote
	hosts over TCP/IP are listed below and described individually in		hosts over TCP/IP are listed below and described individually in
	sections that follow:		sections that follow:
Line 102:		Line 102:
	For example, the <var>DISPLAY</var> command, and the <var class="product">User Language</var> <var>Print</var> statement and <var>[[Text and Html statements\|Html]]</var> statement block are all print operations;		For example, the <var>DISPLAY</var> command, and the <var class="product">User Language</var> <var>Print</var> statement and <var>[[Text and Html statements\|Html]]</var> statement block are all print operations;
	if they are invoked while print is captured to one or more sockets, their output lines are sent to the sockets.		if they are invoked while print is captured to one or more sockets, their output lines are sent to the sockets.
	A print line is sent followed by the socket's current <var>[[LINEND (JANUS DEFINE parameter)\|LINEND]]</var> value, if any. See [[$Sock_Capture#Print capturing hierarchy and other considerations\|"Print capturing hierarchy and other considerations"]] and		A print line is sent followed by the socket's current <var>[[LINEND (JANUS DEFINE parameter)\|LINEND]]</var> value, if any. See [[$Sock_Capture#Print capturing hierarchy and other considerations\|Print capturing hierarchy and other considerations]] and
	[[Sample Janus Sockets programs#Print capturing example\|"Print capturing example"]].		[[Sample Janus Sockets programs#Print capturing example\|Print capturing example]].
	</td></tr>		</td></tr>
	</table>		</table>
Line 109:		Line 109:
	==CALLing Sirius $functions==		==CALLing Sirius $functions==
	You can invoke many of the Sirius $functions		You can invoke many of the Sirius $functions
	using a <var class="product">~~User Language~~</var> <var>Call</var> statement instead of assigning the function		using a <var class="product">SOUL</var> <var>Call</var> statement instead of assigning the function
	result to a %variable.		result to a %variable.
	For example:		For example:

JAL: /* See also */

2013-04-26T15:15:12Z

JAL: /* CALLing Sirius $functions */

2013-04-25T19:08:16Z

CALLing Sirius $functions

@@ Line 133: / Line 133: @@
 an indicator of whether the function completed successfully.
 <var>[[$ListCnt]]</var>, for example, is a (non-callable) $function that just returns a value.
 [[Category:Janus Sockets]]

JAL: /* Janus Sockets $function summary */

2013-04-25T19:04:35Z

Janus Sockets $function summary

← Older revision		Revision as of 19:04, 25 April 2013
Line 27:		Line 27:
	sections that follow:		sections that follow:
	<table>		<table>
	<tr><th>[[$Sock_Capture]]		<tr><td>[[$Sock_Capture]]</td>
	</th><td>Change print capture setting		<td>Change print capture setting</td></tr>

			<tr><td>[[$Sock_Cert_Info]]</td>
			<td>Get value of entity in partner's certificate
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_Cert_Info~~]]
	</th><td>Get ~~value~~ of ~~entity~~ in partner's certificate		<tr><td>[[$Sock_Cert_Levels]]</td>
			<td>Get number of levels in partner's certificate
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_Cert_Levels~~]]
	</th><td>~~Get number~~ of ~~levels in partner'~~s ~~certificate~~		<tr><td>[[$Sock_Close]]</td>
			<td>Terminate sending and receiving of data on, and remove from use, one or all <var class="product">Janus Sockets</var> connection(s)
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_Close~~]]
	</th><td>~~Terminate sending and receiving of data on, and remove from use, one or all <var class="product">Janus Sockets</var>~~ connection~~(s)~~		<tr><td>[[$Sock_Conn]]</td>
			<td>Create connection to remote host using CLSOCK port
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_Conn~~]]
	</th><td>~~Create connection to remote host using CLSOCK port~~		<tr><td>[[$Sock_ErrInfo]]</td>
			<td>Get info about last <var class="product">Janus Sockets</var> error
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_ErrInfo~~]]
	</th><td>Get info about ~~last <var class="product">Janus Sockets</var> error~~		<tr><td>[[$Sock_Info]]</td>
			<td>Get info about socket
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_Info~~]]
	</th><td>Get ~~info about~~ socket		<tr><td>[[$Sock_Num]]</td>
			<td>Get selected socket numbers</td></tr>

			<tr><td>[[$Sock_OnReset]]</td>
			<td>Set label to handle <var>RESET</var> conditions
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_Num~~]]
	</th><td>~~Get selected socket numbers~~		<tr><td>[[$Sock_Recv]]</td>
			<td>Receive string based on count
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_OnReset~~]]
	</th><td>~~Set label to handle <var>RESET</var> conditions~~		<tr><td>[[$Sock_RecvPrs]]</td>
			<td>Receive parsed string
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_Recv~~]]
	</th><td>~~Receive~~ string ~~based on count~~		<tr><td>[[$Sock_Send]]</td>
			<td>Send string
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_RecvPrs~~]]
	</th><td>~~Receive parsed~~ string		<tr><td>[[$Sock_SendLn]]</td>
			<td>Send string followed by <var>LINEND</var>
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_Send~~]]
	</th><td>~~Send string~~		<tr><td>[[$Sock_Set]]</td>
			<td>Change parameter or setting on one or all sockets
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_SendLn~~]]
	</th><td>~~Send string followed by <var>LINEND</var>~~		<tr><td>[[$Sock_SSL_On]]</td>
			<td>Switch to SSL processing on a socket
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_Set~~]]
	</th><td>~~Change parameter or setting on one or all sockets~~		<tr><td>[[$Sock_Tran_In]]</td>
			<td>Translate string, from character set of remote, to local internal character set ("EBCDIC")
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_SSL_On~~]]
	</th><td>~~Switch~~ to ~~SSL processing on a socket~~		<tr><td>[[$Sock_Tran_Out]]</td>
			<td>Translate string, from local internal character set ("EBCDIC"), to character set of remote
	</td></tr>		</td></tr>
	<tr><th>[[$~~Sock_Tran_In~~]]
	</th><td>~~Translate string, from character set of remote, to local internal character set (~~"~~EBCDIC~~")		<tr><td>[[$Sock_URL_Encode]]</td>
			<td>Encode special characters into the URL "% hex hex" format
	</td></tr>		</td></tr>
	~~<tr><th>[[$Sock_Tran_Out]]~~
	~~</th><td>Translate string, from local internal character set ("EBCDIC"), to character set of remote~~		<tr><td>Print operations</td>
	<~~/td></~~tr>		<td>In addition to the above list of $functions, data may be sent over a socket as the result of a "print" operation. This is accomplished by the <var>$Sock_Capture</var> function. Note that print operations outside a <var class="product">User Language</var> request can be captured as well, if a capturing socket has the <var>NOCLOSE</var> setting.
	~~<tr><th>[[$Sock_URL_Encode]]~~
	~~</th~~><td>~~Encode special characters into the URL "% hex hex" format~~
	</td~~></tr~~>
	~~<tr><th>Print operations~~
	~~</th>~~<td>In addition to the above list of $functions, data may be sent over a socket as the result of a "print" operation. This is accomplished by the <var>$Sock_Capture</var> function. Note that print operations outside a <var class="product">User Language</var> request can be captured as well, if a capturing socket has the <var>NOCLOSE</var> setting.

	For example, the <var>DISPLAY</var> command, and the <var class="product">User Language</var> <var>Print</var> statement and <var>[[Text and Html statements\|Html]]</var> statement block are all print operations;		For example, the <var>DISPLAY</var> command, and the <var class="product">User Language</var> <var>Print</var> statement and <var>[[Text and Html statements\|Html]]</var> statement block are all print operations;
Line 88:		Line 104:
	A print line is sent followed by the socket's current <var>[[LINEND (JANUS DEFINE parameter)\|LINEND]]</var> value, if any. See [[$Sock_Capture#Print capturing hierarchy and other considerations\|"Print capturing hierarchy and other considerations"]] and		A print line is sent followed by the socket's current <var>[[LINEND (JANUS DEFINE parameter)\|LINEND]]</var> value, if any. See [[$Sock_Capture#Print capturing hierarchy and other considerations\|"Print capturing hierarchy and other considerations"]] and
	[[Sample Janus Sockets programs#Print capturing example\|"Print capturing example"]].		[[Sample Janus Sockets programs#Print capturing example\|"Print capturing example"]].
	</td></tr></table>		</td></tr>
			</table>

	==CALLing Sirius $functions==		==CALLing Sirius $functions==

JAL2 at 16:11, 6 June 2012

2012-06-06T16:11:31Z

← Older revision		Revision as of 16:11, 6 June 2012
Line 17:		Line 17:

	Sample programs using $functions are		Sample programs using $functions are
	included in ~~the appendix to this document~~ and in the JANUS file		included in [[Sample Janus Sockets programs\|"Sample Janus Sockets programs"]] and in the JANUS file
	distributed with this product.		distributed with this product.

			__TOC__

	==Janus Sockets $function summary==		==Janus Sockets $function summary==
	The <var class="product">Janus Sockets</var> <var class="product">User Language</var> $functions for communicating with remote		The <var class="product">Janus Sockets</var> <var class="product">User Language</var> $functions for communicating with remote

JAL2 at 16:08, 6 June 2012

2012-06-06T16:08:44Z

@@ Line 87: / Line 87: @@
 [[Sample Janus Sockets programs#Print capturing example|"Print capturing example"]].
 </td></tr></table>
 [[Category:Janus Sockets]]

JAL2 at 15:39, 6 June 2012

2012-06-06T15:39:07Z

← Older revision		Revision as of 15:39, 6 June 2012
Line 20:		Line 20:
	distributed with this product.		distributed with this product.

	==~~<var class="product">~~Janus Sockets~~</var>~~ $function summary==		==Janus Sockets $function summary==
	The <var class="product">Janus Sockets</var> <var class="product">User Language</var> $functions for communicating with remote		The <var class="product">Janus Sockets</var> <var class="product">User Language</var> $functions for communicating with remote
	hosts over TCP/IP are listed below and described individually in		hosts over TCP/IP are listed below and described individually in
	sections that follow:		sections that follow:
	<table>		<table>
	<tr><th>$Sock_Capture		<tr><th>[[$Sock_Capture]]
	</th><td>Change print capture setting		</th><td>Change print capture setting
	</td></tr>		</td></tr>
	<tr><th>$Sock_Cert_Info		<tr><th>[[$Sock_Cert_Info]]
	</th><td>Get value of entity in partner's certificate		</th><td>Get value of entity in partner's certificate
	</td></tr>		</td></tr>
	<tr><th>$Sock_Cert_Levels		<tr><th>[[$Sock_Cert_Levels]]
	</th><td>Get number of levels in partner's certificate		</th><td>Get number of levels in partner's certificate
	</td></tr>		</td></tr>
	<tr><th>$Sock_Close		<tr><th>[[$Sock_Close]]
	</th><td>Terminate sending and receiving of data on, and remove from use, one or all <var class="product">Janus Sockets</var> connection(s)		</th><td>Terminate sending and receiving of data on, and remove from use, one or all <var class="product">Janus Sockets</var> connection(s)
	</td></tr>		</td></tr>
	<tr><th>$Sock_Conn		<tr><th>[[$Sock_Conn]]
	</th><td>Create connection to remote host using CLSOCK port		</th><td>Create connection to remote host using CLSOCK port
	</td></tr>		</td></tr>
	<tr><th>$Sock_ErrInfo		<tr><th>[[$Sock_ErrInfo]]
	</th><td>Get info about last <var class="product">Janus Sockets</var> error		</th><td>Get info about last <var class="product">Janus Sockets</var> error
	</td></tr>		</td></tr>
	<tr><th>$Sock_Info		<tr><th>[[$Sock_Info]]
	</th><td>Get info about socket		</th><td>Get info about socket
	</td></tr>		</td></tr>
	<tr><th>$Sock_Num		<tr><th>[[$Sock_Num]]
	</th><td>Get selected socket numbers		</th><td>Get selected socket numbers
	</td></tr>		</td></tr>
	<tr><th>$Sock_OnReset		<tr><th>[[$Sock_OnReset]]
	</th><td>Set label to handle <var>RESET</var> conditions		</th><td>Set label to handle <var>RESET</var> conditions
	</td></tr>		</td></tr>
	<tr><th>$Sock_Recv		<tr><th>[[$Sock_Recv]]
	</th><td>Receive string based on count		</th><td>Receive string based on count
	</td></tr>		</td></tr>
	<tr><th>$Sock_RecvPrs		<tr><th>[[$Sock_RecvPrs]]
	</th><td>Receive parsed string		</th><td>Receive parsed string
	</td></tr>		</td></tr>
	<tr><th>$Sock_Send		<tr><th>[[$Sock_Send]]
	</th><td>Send string		</th><td>Send string
	</td></tr>		</td></tr>
	<tr><th>$Sock_SendLn		<tr><th>[[$Sock_SendLn]]
	</th><td>Send string followed by <var>LINEND</var>		</th><td>Send string followed by <var>LINEND</var>
	</td></tr>		</td></tr>
	<tr><th>$Sock_Set		<tr><th>[[$Sock_Set]]
	</th><td>Change parameter or setting on one or all sockets		</th><td>Change parameter or setting on one or all sockets
	</td></tr>		</td></tr>
	<tr><th>$Sock_SSL_On		<tr><th>[[$Sock_SSL_On]]
	</th><td>Switch to SSL processing on a socket		</th><td>Switch to SSL processing on a socket
	</td></tr>		</td></tr>
	<tr><th>$Sock_Tran_In		<tr><th>[[$Sock_Tran_In]]
	</th><td>Translate string, from character set of remote, to local internal character set ("EBCDIC")		</th><td>Translate string, from character set of remote, to local internal character set ("EBCDIC")
	</td></tr>		</td></tr>
	<tr><th>$Sock_Tran_Out		<tr><th>[[$Sock_Tran_Out]]
	</th><td>Translate string, from local internal character set ("EBCDIC"), to character set of remote		</th><td>Translate string, from local internal character set ("EBCDIC"), to character set of remote
	</td></tr>		</td></tr>
	<tr><th>$Sock_URL_Encode		<tr><th>[[$Sock_URL_Encode]]
	</th><td>Encode special characters into the URL "% hex hex" format		</th><td>Encode special characters into the URL "% hex hex" format
	</td></tr>		</td></tr>
	<tr><th>Print operations		<tr><th>Print operations
	</th><td>In addition to the above list of $functions, data may be sent over a socket as the result of a "print" operation. This is accomplished by the <var>[[$Sock_Capture]]</var> function. Note that print operations outside a <var class="product">User Language</var> request can be captured as well, if a capturing socket has the <var>NOCLOSE</var> setting.		</th><td>In addition to the above list of $functions, data may be sent over a socket as the result of a "print" operation. This is accomplished by the <var>$Sock_Capture</var> function. Note that print operations outside a <var class="product">User Language</var> request can be captured as well, if a capturing socket has the <var>NOCLOSE</var> setting.

	For example, the <var>DISPLAY</var> command, and the <var class="product">User Language</var> <var>Print</var> statement and <var>[[Text and Html statements\|Html]]</var> statement block are all print operations;		For example, the <var>DISPLAY</var> command, and the <var class="product">User Language</var> <var>Print</var> statement and <var>[[Text and Html statements\|Html]]</var> statement block are all print operations;

JAL2 at 18:10, 10 February 2012

2012-02-10T18:10:57Z

← Older revision		Revision as of 18:10, 10 February 2012
Line 82:		Line 82:
	</th><td>In addition to the above list of $functions, data may be sent over a socket as the result of a "print" operation. This is accomplished by the <var>[[$Sock_Capture]]</var> function. Note that print operations outside a <var class="product">User Language</var> request can be captured as well, if a capturing socket has the <var>NOCLOSE</var> setting.		</th><td>In addition to the above list of $functions, data may be sent over a socket as the result of a "print" operation. This is accomplished by the <var>[[$Sock_Capture]]</var> function. Note that print operations outside a <var class="product">User Language</var> request can be captured as well, if a capturing socket has the <var>NOCLOSE</var> setting.

	For example, the <var>DISPLAY</var> command, and the <var class="product">User Language</var> <var>Print</var> statement and <var>[[Html ~~and Text~~ statements\|Html]]</var> statement block are all print operations;		For example, the <var>DISPLAY</var> command, and the <var class="product">User Language</var> <var>Print</var> statement and <var>[[Text and Html statements\|Html]]</var> statement block are all print operations;
	if they are invoked while print is captured to one or more sockets, their output lines are sent to the sockets.		if they are invoked while print is captured to one or more sockets, their output lines are sent to the sockets.
	A print line is sent followed by the socket's current <var>[[LINEND (JANUS DEFINE parameter)\|LINEND]]</var> value, if any. See [[$Sock_Capture#Print capturing hierarchy and other considerations\|"Print capturing hierarchy and other considerations"]] and		A print line is sent followed by the socket's current <var>[[LINEND (JANUS DEFINE parameter)\|LINEND]]</var> value, if any. See [[$Sock_Capture#Print capturing hierarchy and other considerations\|"Print capturing hierarchy and other considerations"]] and

JAL2 at 22:11, 20 January 2012

2012-01-20T22:11:13Z

← Older revision		Revision as of 22:11, 20 January 2012
Line 14:		Line 14:
	used: for example, a socket port must be connected before data is sent using it,		used: for example, a socket port must be connected before data is sent using it,
	and data may not be sent after the <var>FIN</var> indicator is sent.		and data may not be sent after the <var>FIN</var> indicator is sent.
	For more information about <var class="product">Janus Sockets</var> programming, see [[Janus Sockets User Language coding		For more information about <var class="product">Janus Sockets</var> programming, see [[Janus Sockets User Language coding considerations\|"Janus Sockets User Language coding considerations"]].
	considerations\|Janus Sockets User Language coding considerations"]].

	Sample programs using $functions are		Sample programs using $functions are

JAL2: Created page with "The `User Language` sockets API is implemented as the `Janus Sockets` $function set. The Janus SOAP 2012-01-20T22:09:06Z Created page with "The <var class="product">User Language</var> sockets API is implemented as the <var class="product">Janus Sockets</var> $function set. The <var class="product">Janus SOAP</va..." New page The <var class="product">User Language</var> sockets API is implemented as the <var class="product">Janus Sockets</var> $function set. The <var class="product">[[Janus SOAP]]</var> <var>[[Socket class|Socket]]</var>, <var>[[HTTP Helper]]</var>, <var>[[Email class|Email]]</var>, and <var>[[LDAP class|LDAP]]</var> objects and methods are alternatives that generalize the <var class="product">Janus Sockets</var> $functions and are designed to be easier to use. These $functions and object methods provide <var class="product">User Language</var> programs with the ability to receive and send using socket ports. This topic is primarily concerned with how to use the individual $functions, though much of its text applies as well to the <var>Socket</var> object methods that are largely analogous to the $functions. There are a few restrictions on the order in which the <var class="product">Janus Sockets</var> $functions are used: for example, a socket port must be connected before data is sent using it, and data may not be sent after the <var>FIN</var> indicator is sent. For more information about <var class="product">Janus Sockets</var> programming, see [[Janus Sockets User Language coding considerations|Janus Sockets User Language coding considerations"]]. Sample programs using $functions are included in the appendix to this document and in the JANUS file distributed with this product. ==<var class="product">Janus Sockets</var> $function summary== The <var class="product">Janus Sockets</var> <var class="product">User Language</var> $functions for communicating with remote hosts over TCP/IP are listed below and described individually in sections that follow: <table> <tr><th>$Sock_Capture </th><td>Change print capture setting </td></tr> <tr><th>$Sock_Cert_Info </th><td>Get value of entity in partner's certificate </td></tr> <tr><th>$Sock_Cert_Levels </th><td>Get number of levels in partner's certificate </td></tr> <tr><th>$Sock_Close </th><td>Terminate sending and receiving of data on, and remove from use, one or all <var class="product">Janus Sockets</var> connection(s) </td></tr> <tr><th>$Sock_Conn </th><td>Create connection to remote host using CLSOCK port </td></tr> <tr><th>$Sock_ErrInfo </th><td>Get info about last <var class="product">Janus Sockets</var> error </td></tr> <tr><th>$Sock_Info </th><td>Get info about socket </td></tr> <tr><th>$Sock_Num </th><td>Get selected socket numbers </td></tr> <tr><th>$Sock_OnReset </th><td>Set label to handle <var>RESET</var> conditions </td></tr> <tr><th>$Sock_Recv </th><td>Receive string based on count </td></tr> <tr><th>$Sock_RecvPrs </th><td>Receive parsed string </td></tr> <tr><th>$Sock_Send </th><td>Send string </td></tr> <tr><th>$Sock_SendLn </th><td>Send string followed by <var>LINEND</var> </td></tr> <tr><th>$Sock_Set </th><td>Change parameter or setting on one or all sockets </td></tr> <tr><th>$Sock_SSL_On </th><td>Switch to SSL processing on a socket </td></tr> <tr><th>$Sock_Tran_In </th><td>Translate string, from character set of remote, to local internal character set ("EBCDIC") </td></tr> <tr><th>$Sock_Tran_Out </th><td>Translate string, from local internal character set ("EBCDIC"), to character set of remote </td></tr> <tr><th>$Sock_URL_Encode </th><td>Encode special characters into the URL "% hex hex" format </td></tr> <tr><th>Print operations </th><td>In addition to the above list of $functions, data may be sent over a socket as the result of a "print" operation. This is accomplished by the <var>[[$Sock_Capture]]</var> function. Note that print operations outside a <var class="product">User Language</var> request can be captured as well, if a capturing socket has the <var>NOCLOSE</var> setting. For example, the <var>DISPLAY</var> command, and the <var class="product">User Language</var> <var>Print</var> statement and <var>[[Html and Text statements|Html]]</var> statement block are all print operations; if they are invoked while print is captured to one or more sockets, their output lines are sent to the sockets. A print line is sent followed by the socket's current <var>[[LINEND (JANUS DEFINE parameter)|LINEND]]</var> value, if any. See [[$Sock_Capture#Print capturing hierarchy and other considerations|"Print capturing hierarchy and other considerations"]] and [[Sample Janus Sockets programs#Print capturing example|"Print capturing example"]]. </td></tr></table> [[Category:Janus Sockets]]

← Older revision		Revision as of 15:15, 26 April 2013
Line 136:		Line 136:
	==See also==		==See also==
	<ul>		<ul>
			<li>[[Janus Sockets User Language coding considerations]]
	<li>[[Sample Janus Sockets programs]]		<li>[[Sample Janus Sockets programs]]
	<li>Socket-level interfaces:		<li>Socket-level interfaces: