New (Socket constructor) - Revision history

JAL: minor cleanup

2016-02-29T16:34:15Z

minor cleanup

← Older revision		Revision as of 16:34, 29 February 2016
Line 107:		Line 107:
	</p>		</p>
	<p>		<p>
	Using the <var>New</var> constructor's named parameters, ~~introduced in <var class="product">Sirmods</var> version 6.7,~~		Using the <var>New</var> constructor's named parameters, the previous example becomes: </p>
	the previous example becomes: </p>
	<p class="code">%socket = new(, host='afl.com.au', port=80) </p>		<p class="code">%socket = new(, host='afl.com.au', port=80) </p>
	<p>		<p>
	Using these names to connect to Sirius Software's secure port, and omitting		Using these names to connect to <code>Sirius Software</code>'s secure port, and omitting
	the initial comma, which the named arguments make optional), gives this: </p>		the initial comma, which the named arguments make optional), gives this: </p>
	<p class="code">%socket = new(host='sirius-software.com', port=443, ssl='SSL')		<p class="code">%socket = new(host='sirius-software.com', port=443, ssl='SSL')

JAL: /* Usage notes */ add link

2016-02-02T20:21:33Z

Usage notes: add link

← Older revision		Revision as of 20:21, 2 February 2016
Line 50:		Line 50:
	<ul>		<ul>
	<li>If the <var>New</var> method connection attempt fails, the object variable is set to		<li>If the <var>New</var> method connection attempt fails, the object variable is set to
	null, and <var>$~~Statusd~~</var> is set to what would be the return code value if		null, and <var>[[$StatusD]]</var> is set to what would be the return code value if
	the same error had happened with <var>[[$Sock_Conn]]</var>, the <var class="product">Janus Sockets</var> $function		the same error had happened with <var>[[$Sock_Conn]]</var>, the <var class="product">Janus Sockets</var> $function
	that creates a socket connection.		that creates a socket connection.
Line 57:		Line 57:
	the following error handler can be used after the <var>New</var> constructor: </p>		the following error handler can be used after the <var>New</var> constructor: </p>
	<p class="code">If %socko Is Null Then		<p class="code">If %socko Is Null Then
	Print 'Error:' And $~~STATUSD~~		Print 'Error:' And $statusd
	Stop		Stop
	End If		End If

JAL2 at 21:48, 7 August 2012

2012-08-07T21:48:28Z

← Older revision		Revision as of 21:48, 7 August 2012
Line 28:		Line 28:
	<tr><th><var>Port</var></th>		<tr><th><var>Port</var></th>
	<td>The number of the port on the remote host to which the socket will connect. The parameter name, <var>Port</var> (case not important), is allowed as a qualifier.		<td>The number of the port on the remote host to which the socket will connect. The parameter name, <var>Port</var> (case not important), is allowed as a qualifier.
	<p>If a port number is specified on the <var>[[REMOTE]]</var> clause of the port definition, the <var ~~class="term"~~>Port</var> value can be the matching number, it can be -1, or it can be omitted. If an asterisk (<tt>*</tt>) is specified for the remote port on the port definition, a <var ~~class="term"~~>Port</var> value must be specified. </p>		<p>If a port number is specified on the <var>[[REMOTE]]</var> clause of the port definition, the <var>Port</var> value can be the matching number, it can be -1, or it can be omitted. If an asterisk (<tt>*</tt>) is specified for the remote port on the port definition, a <var>Port</var> value must be specified. </p>
	<p>The port number may also be restricted by <var>JANUS CLSOCK ALLOW</var> rules. </p></td></tr>		<p>The port number may also be restricted by <var>JANUS CLSOCK ALLOW</var> rules. </p></td></tr>

JAL2: /* Syntax terms */

2012-06-19T20:08:13Z

Syntax terms

← Older revision		Revision as of 20:08, 19 June 2012
Line 14:		Line 14:
	<td>A variable that is a reference to a <var>Socket</var> object. </td></tr>		<td>A variable that is a reference to a <var>Socket</var> object. </td></tr>

	<tr><th><var>[%(Socket)]</var>		<tr><th><var>[%(Socket):]</var>
	<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Socket</var> <var>Constructor</var>.</td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Socket</var> <var>Constructor</var>.</td></tr>

JAL2: /* Syntax terms */

2012-06-08T20:15:11Z

Syntax terms

← Older revision		Revision as of 20:15, 8 June 2012
Line 13:		Line 13:
	<tr><th>%socket</th>		<tr><th>%socket</th>
	<td>A variable that is a reference to a <var>Socket</var> object. </td></tr>		<td>A variable that is a reference to a <var>Socket</var> object. </td></tr>

	<tr><th><var>[%(Socket)]</var>		<tr><th><var>[%(Socket)]</var>
	<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Socket</var> <var>Constructor</var>.</td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Socket</var> <var>Constructor</var>.</td></tr>

	<tr><th><var>ClientPort</var></th>		<tr><th><var>ClientPort</var></th>
	<td>This optional, [[Notation conventions for methods#Named parameters\|name allowed]], parameter is the name of the client socket port. The default is the <var>[[MASTER]]</var> port, if any is defined. However, if you omit a value for this parameter and no <var>MASTER</var> port is defined, the request is canceled. </td></tr>		<td>This optional, [[Notation conventions for methods#Named parameters\|name allowed]], parameter is the name of the client socket port. The default is the <var>[[MASTER]]</var> port, if any is defined. However, if you omit a value for this parameter and no <var>MASTER</var> port is defined, the request is canceled. </td></tr>

	<tr><th><var>Host</var></th>		<tr><th><var>Host</var></th>
	<td>The name or IP address of the remote host. This argument is optional; if you specify a value, the parameter name, <var>Host</var> (case not important), is [[Notation conventions for methods#Named parameters\|allowed]] as a qualifier.		<td>The name or IP address of the remote host. This argument is optional; if you specify a value, the parameter name, <var>Host</var> (case not important), is [[Notation conventions for methods#Named parameters\|allowed]] as a qualifier.
Line 22:		Line 25:
	<p>If <var class="term">hostid</var> is specified and is not the null string, it must match the remote host specified explicitly or indicated by a pattern on the port definition. If an asterisk (<tt>*</tt>) is specified for the remote host on the port definition, <var class="term">hostid</var> must be specified. </p>		<p>If <var class="term">hostid</var> is specified and is not the null string, it must match the remote host specified explicitly or indicated by a pattern on the port definition. If an asterisk (<tt>*</tt>) is specified for the remote host on the port definition, <var class="term">hostid</var> must be specified. </p>
	<p>The remote host may also be restricted by <var>[[JANUS CLSOCK#JANUS CLSOCK ALLOW\|JANUS CLSOCK ALLOW]]</var> rules. </p></td></tr>		<p>The remote host may also be restricted by <var>[[JANUS CLSOCK#JANUS CLSOCK ALLOW\|JANUS CLSOCK ALLOW]]</var> rules. </p></td></tr>

	<tr><th><var>Port</var></th>		<tr><th><var>Port</var></th>
	<td>The number of the port on the remote host to which the socket will connect. The parameter name, <var>Port</var> (case not important), is allowed as a qualifier.		<td>The number of the port on the remote host to which the socket will connect. The parameter name, <var>Port</var> (case not important), is allowed as a qualifier.
	<p>If a port number is specified on the <var>[[REMOTE]]</var> clause of the port definition, the <var class="term">Port</var> value can be the matching number, it can be -1, or it can be omitted. If an asterisk (<tt>*</tt>) is specified for the remote port on the port definition, a <var class="term">Port</var> value must be specified. </p>		<p>If a port number is specified on the <var>[[REMOTE]]</var> clause of the port definition, the <var class="term">Port</var> value can be the matching number, it can be -1, or it can be omitted. If an asterisk (<tt>*</tt>) is specified for the remote port on the port definition, a <var class="term">Port</var> value must be specified. </p>
	<p>The port number may also be restricted by <var>JANUS CLSOCK ALLOW</var> rules. </p></td></tr>		<p>The port number may also be restricted by <var>JANUS CLSOCK ALLOW</var> rules. </p></td></tr>

	<tr><th><var>SSL</var></th>		<tr><th><var>SSL</var></th>
	<td>This name allowed, optional, string argument selects whether SSL encryption is attempted for this socket. The case of the parameter name, <var>Ssl</var>, is not important.		<td>This name allowed, optional, string argument selects whether SSL encryption is attempted for this socket. The case of the parameter name, <var>Ssl</var>, is not important.
Line 37:		Line 42:
	</th><td>Do not use SSL over the connection. This selection is invalid if the port definition includes the <var>SSL</var> parameter but not <var>SSLOPT</var>, and it is redundant if the port definition does not include the <var>SSL</var> parameter.		</th><td>Do not use SSL over the connection. This selection is invalid if the port definition includes the <var>SSL</var> parameter but not <var>SSLOPT</var>, and it is redundant if the port definition does not include the <var>SSL</var> parameter.
	</td></tr></table>		</td></tr></table>

	<tr><th><var>TcpKeepAlive</var> </th>		<tr><th><var>TcpKeepAlive</var> </th>
	<td>Setting this name allowed, optional, <var>[[Boolean enumeration\|Boolean]]</var> value to <code>True</code> lets you generate TCP "keepalives" for a particular (probably client) connection, regardless of the <var>[[TCPKEEPALIVE (JANUS DEFINE parameter)\|TCPKEEPALIVE]]</var> parameter setting for the Janus port. Setting <var>TcpKeepAlive</var> to <code>False</code> turns off TCP keepalives even if the port has the <var>TCPKEEPALIVE</var> parameter set.		<td>Setting this name allowed, optional, <var>[[Boolean enumeration\|Boolean]]</var> value to <code>True</code> lets you generate TCP "keepalives" for a particular (probably client) connection, regardless of the <var>[[TCPKEEPALIVE (JANUS DEFINE parameter)\|TCPKEEPALIVE]]</var> parameter setting for the Janus port. Setting <var>TcpKeepAlive</var> to <code>False</code> turns off TCP keepalives even if the port has the <var>TCPKEEPALIVE</var> parameter set.

JAL2 at 18:50, 8 June 2012

2012-06-08T18:50:28Z

← Older revision		Revision as of 18:50, 8 June 2012
Line 16:		Line 16:
	<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Socket</var> <var>Constructor</var>.</td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Socket</var> <var>Constructor</var>.</td></tr>
	<tr><th><var>ClientPort</var></th>		<tr><th><var>ClientPort</var></th>
	<td>~~The~~ name of the client socket port. The default is the <var>[[MASTER]]</var> port, if any is defined. However, if you omit ~~<var class="term">clientport</var>~~ and no <var>MASTER</var> port is defined, the request is canceled. </td></tr>		<td>This optional, [[Notation conventions for methods#Named parameters\|name allowed]], parameter is the name of the client socket port. The default is the <var>[[MASTER]]</var> port, if any is defined. However, if you omit a value for this parameter and no <var>MASTER</var> port is defined, the request is canceled. </td></tr>
	<tr><th><var>Host</var></th>		<tr><th><var>Host</var></th>
	<td>The name or IP address of the remote host. This argument is optional; if you specify a value, the parameter name, <var>Host</var> (case not important), is [[Notation conventions for methods#Named parameters\|allowed]] as a qualifier.		<td>The name or IP address of the remote host. This argument is optional; if you specify a value, the parameter name, <var>Host</var> (case not important), is [[Notation conventions for methods#Named parameters\|allowed]] as a qualifier.
Line 27:		Line 27:
	<p>The port number may also be restricted by <var>JANUS CLSOCK ALLOW</var> rules. </p></td></tr>		<p>The port number may also be restricted by <var>JANUS CLSOCK ALLOW</var> rules. </p></td></tr>
	<tr><th><var>SSL</var></th>		<tr><th><var>SSL</var></th>
	<td>This name-allowed, optional, string argument selects whether SSL encryption is attempted for this socket. The case of the parameter name, <var>Ssl</var>, is not important.		<td>This name allowed, optional, string argument selects whether SSL encryption is attempted for this socket. The case of the parameter name, <var>Ssl</var>, is not important.
	<p><b>Note:</b> Specifying an argument here is only meaningful when the <var>[[JANUS DEFINE]]</var> command for the associated <var>CLSOCK</var> port includes both the <var>[[SSL]]</var> and <var>[[SSLOPT]]</var> parameters. When both these parameters are set in the port definition, SSL encryption is offered on the connection attempt only if the <var>New</var> method explicitly requests it by setting this parameter to <code>SSL</code>. </p>		<p><b>Note:</b> Specifying an argument here is only meaningful when the <var>[[JANUS DEFINE]]</var> command for the associated <var>CLSOCK</var> port includes both the <var>[[SSL]]</var> and <var>[[SSLOPT]]</var> parameters. When both these parameters are set in the port definition, SSL encryption is offered on the connection attempt only if the <var>New</var> method explicitly requests it by setting this parameter to <code>SSL</code>. </p>
	<p>		<p>
Line 38:		Line 38:
	</td></tr></table>		</td></tr></table>
	<tr><th><var>TcpKeepAlive</var> </th>		<tr><th><var>TcpKeepAlive</var> </th>
	<td>		<td>Setting this name allowed, optional, <var>[[Boolean enumeration\|Boolean]]</var> value to <code>True</code> lets you generate TCP "keepalives" for a particular (probably client) connection, regardless of the <var>[[TCPKEEPALIVE (JANUS DEFINE parameter)\|TCPKEEPALIVE]]</var> parameter setting for the Janus port. Setting <var>TcpKeepAlive</var> to <code>False</code> turns off TCP keepalives even if the port has the <var>TCPKEEPALIVE</var> parameter set.
	</td></tr></table>		</td></tr></table>

JAL2: /* Syntax terms */

2011-11-30T17:29:38Z

Syntax terms

← Older revision		Revision as of 17:29, 30 November 2011
Line 13:		Line 13:
	<tr><th>%socket</th>		<tr><th>%socket</th>
	<td>A variable that is a reference to a <var>Socket</var> object. </td></tr>		<td>A variable that is a reference to a <var>Socket</var> object. </td></tr>
	<tr><th><var>%(Socket)</var>		<tr><th><var>[%(Socket)]</var>
	<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Socket</var> <var>Constructor</var>.</td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Socket</var> <var>Constructor</var>.</td></tr>
	<tr><th><var>ClientPort</var></th>		<tr><th><var>ClientPort</var></th>

JAL2 at 01:44, 22 November 2011

2011-11-22T01:44:43Z

← Older revision		Revision as of 01:44, 22 November 2011
Line 1:		Line 1:
	{{Template:Socket:New subtitle}}		{{Template:Socket:New subtitle}}

	~~This [[Notation conventions for methods#Shared members\|shared]] method~~ creates an instance of a <var>Socket</var> object, a		<var>New</var> creates an instance of a <var>Socket</var> object, a connection to a remote host using a Janus
	connection to a remote host using a Janus
	client socket (<var>[[JANUS DEFINE#type\|CLSOCK]]</var>) port.		client socket (<var>[[JANUS DEFINE#type\|CLSOCK]]</var>) port.
	The <var>New</var> constructor is similar in effect to <var>[[$Sock_Conn]]</var>		The <var>New</var> constructor is similar in effect to <var>[[$Sock_Conn]]</var>
Line 15:		Line 14:
	<td>A variable that is a reference to a <var>Socket</var> object. </td></tr>		<td>A variable that is a reference to a <var>Socket</var> object. </td></tr>
	<tr><th><var>%(Socket)</var>		<tr><th><var>%(Socket)</var>
	<td>The class name in parentheses denotes a ~~shared method~~. ~~Specifying~~ <~~code~~>%(Socket):</~~code~~> ~~is not the only way to invoke the method (see :hdref refid=themeth.)~~. </td></tr>		<td>The optional class name in parentheses denotes a <var>[[Notation conventions for methods#Constructors\|Constructor]]</var>. See [[#Usage notes\|"Usage notes"]], below, for more information about invoking a <var>Socket</var> <var>Constructor</var>.</td></tr>
	<tr><th><var>ClientPort</var></th>		<tr><th><var>ClientPort</var></th>
	<td>The name of the client socket port. The default is the <var>[[MASTER]]</var> port, if any is defined. However, if you omit <var class="term">clientport</var> and no <var>MASTER</var> port is defined, the request is canceled. </td></tr>		<td>The name of the client socket port. The default is the <var>[[MASTER]]</var> port, if any is defined. However, if you omit <var class="term">clientport</var> and no <var>MASTER</var> port is defined, the request is canceled. </td></tr>
Line 82:		Line 81:
	...		...
	</p>		</p>
			<li>As described in [[Object variables#Using New or other Constructors\|"Using New or other Constructors"]], <var>New</var> can be invoked with no object, with an explicit class name, or with an object variable in the class, even if that object is <var>Null</var>:<p class="code">%sock = new

			%sock = %(Socket):new

			%sock = %sock:new
			</p>

	<li>An explicit <var>Discard</var> of the <var>Socket</var> object is not permitted.		<li>An explicit <var>Discard</var> of the <var>Socket</var> object is not permitted.
	You use the <var>[[Close (Socket function)\|Close]]</var> method to close the socket and discard the <var>Socket</var> object.		You use the <var>[[Close (Socket function)\|Close]]</var> method to close the socket and discard the <var>Socket</var> object.

JAL2 at 01:02, 22 November 2011

2011-11-22T01:02:11Z

← Older revision		Revision as of 01:02, 22 November 2011
Line 5:		Line 5:
	client socket (<var>[[JANUS DEFINE#type\|CLSOCK]]</var>) port.		client socket (<var>[[JANUS DEFINE#type\|CLSOCK]]</var>) port.
	The <var>New</var> constructor is similar in effect to <var>[[$Sock_Conn]]</var>		The <var>New</var> constructor is similar in effect to <var>[[$Sock_Conn]]</var>
	and has the same argument list. ~~</p>~~		and has the same argument list.

	==Syntax==		==Syntax==

JAL2 at 01:55, 15 November 2011

2011-11-15T01:55:13Z

← Older revision		Revision as of 01:55, 15 November 2011
Line 67:		Line 67:
	all client requests on port <code>SOCKEM</code> will go to port <code>80</code> at host IP		all client requests on port <code>SOCKEM</code> will go to port <code>80</code> at host IP
	address <code>198.242.244.47</code>, specifying the destination on the function		address <code>198.242.244.47</code>, specifying the destination on the function
	call is superfluous.		call is superfluous. </p>
	<p class="code">JANUS DEFINE SOCKEM * CLSOCK 5 REMOTE 198.242.244.47 80		<p class="code">JANUS DEFINE SOCKEM * CLSOCK 5 REMOTE 198.242.244.47 80
	Begin		Begin
	...		...
	%sock = New('SOCKEM')		%sock = New('SOCKEM')
	...		...
	</p>		</p>
	In the example below, the port is defined to accept client requests to any remote port.		In the example below, the port is defined to accept client requests to any remote port.
Line 88:		Line 88:
	==Examples==		==Examples==
	If a <var>[[MASTER]]</var> <var>CLSOCK</var> port is defined,		If a <var>[[MASTER]]</var> <var>CLSOCK</var> port is defined,
	a <var>New</var> method invocation does not need to specify a client socket name &~~amp;~~mdash; the		a <var>New</var> method invocation does not need to specify a client socket name — the
	<var>MASTER</var> <var>CLSOCK</var> port is used by default.		<var>MASTER</var> <var>CLSOCK</var> port is used by default.
	In this circumstance, the following statement would create a		In this circumstance, the following statement would create a