SSLOn (Socket function) - Revision history

JAL at 18:08, 12 August 2014

2014-08-12T18:08:16Z

← Older revision		Revision as of 18:08, 12 August 2014
Line 2:		Line 2:
	This [[Notation conventions for methods#Callable functions\|callable]] method turns on SSL processing, that is, starts an SSL handshake as a client		This [[Notation conventions for methods#Callable functions\|callable]] method turns on SSL processing, that is, starts an SSL handshake as a client
	on a connection.		on a connection.
	<var>SSLOn</var> has an effect similar to <var>[[$~~Sock_Ssl_On~~]]</var>.		<var>SSLOn</var> has an effect similar to <var>[[$Sock_SSL_On]]</var>.

	==Syntax==		==Syntax==
Line 10:		Line 10:
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%number</th>		<tr><th>%number</th>
	<td>~~This is a~~ numeric variable to contain the returned indicator of success of the function.		<td>A numeric variable to contain the returned indicator of success of the function.
	The possible return values are listed in [[#Return codes\|"Return codes"]] below. </td></tr>		The possible return values are listed in [[#Return codes\|Return codes]] below. </td></tr>

	<tr><th>socket</th>		<tr><th>socket</th>
Line 19:		Line 19:
	===Return codes===		===Return codes===
	The method's return value (<var class="term">%number</var>) is one of these:		The method's return value (<var class="term">%number</var>) is one of these:
	<table>		<table class="thJustBold">
	<tr><th>  0</th>		<tr><th>  0</th>
	<td>Successfully switched to SSL.</td></tr>		<td>Successfully switched to SSL.</td></tr>

	<tr><th>-110</th>		<tr><th>-110</th>
	<td>Attempted on non-SSL port. <var>SSLOn</var> can only be attempted on a port with <var>[[SSL]]</var> and <var>[[SSLOPT]]</var> on the <var>[[JANUS DEFINE]]</var> command.</td></tr>		<td>Attempted on non-SSL port. <var>SSLOn</var> can only be attempted on a port with <var>[[SSL]]</var> and <var>[[SSLOPT]]</var> on the <var>[[JANUS DEFINE]]</var> command.</td></tr>

	<tr><th>-111</th>		<tr><th>-111</th>
	<td>SSL handshake error. Likely result of trying to use the <var>SSLOn</var> method against a non-SSL port.</td></tr>		<td>SSL handshake error. Likely result of trying to use the <var>SSLOn</var> method against a non-SSL port.</td></tr>

	<tr><th>-112</th>		<tr><th>-112</th>
	<td>Have pending incoming data. The <var>SSLOn</var> method is invalid until all incoming (presumably) non-SSL data has been received.</td></tr>		<td>Have pending incoming data. The <var>SSLOn</var> method is invalid until all incoming (presumably) non-SSL data has been received.</td></tr>

	<tr><th>-149</th>		<tr><th>-149</th>
	<td>Other error during connection.</td></tr>		<td>Other error during connection.</td></tr>
Line 33:		Line 37:

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li><var>SSLOn</var> makes it possible to:		<li><var>SSLOn</var> makes it possible to:
	<ol>		<ol>
	<li>Make an initial connection from a <var class="product">Janus Sockets</var> client application to a proxy server		<li>Make an initial connection from a <var class="product">Janus Sockets</var> client application to a proxy server
	<li>Issue the HTTP CONNECT
	method/command to connect to a server through the proxy		<li>Issue the HTTP CONNECT method/command to connect to a server through the proxy
	<li>Communicate via SSL with the back end server, simply having the proxy server
	act as a "tunnel" for the SSL data		<li>Communicate via SSL with the back end server, simply having the proxy server
	</ol>		act as a "tunnel" for the SSL data
			</ol> </li>
	As shown in [[#Examples\|"Examples"]] below, the <var>SSLOn</var> method should be
			<li>As shown in [[#Examples\|Examples]] below, the <var>SSLOn</var> method should be
	used after a positive response has been received for a CONNECT method		used after a positive response has been received for a CONNECT method
	request on a <var class="product">Janus Sockets</var> client socket.		request on a <var class="product">Janus Sockets</var> client socket. </li>
	</ul>		</ul>

	==Examples==		==Examples==

	The following code shows the use of the <var>SSLOn</var> method;		The following code shows the use of the <var>SSLOn</var> method;
	<p class="code">%sock is Object <var>Socket</var>		<p class="code">%sock is Object <var>Socket</var>

JAL2 at 18:37, 11 June 2012

2012-06-11T18:37:13Z

@@ Line 1: / Line 1: @@
 {{Template:Socket:SSLOn subtitle}}
 ==Syntax==
 {{Template:Socket:SSLOn syntax}}
 ===Syntax terms===
 <table class="syntaxTable">
-<tr><th>%number</th><td>number</td></tr>
+<tr><th>%number</th>
 <tr><th>socket</th>
 <td>A variable or an expression that is a reference to a <var>Socket</var> object.</td></tr>
 </table>
 ==Usage notes==
 ==Examples==
 ==See also==
 {{Template:Socket:SSLOn footer}}

JAL2: /* Syntax terms */

2011-11-15T02:02:36Z

Syntax terms

← Older revision		Revision as of 02:02, 15 November 2011
Line 8:		Line 8:
	<tr><th>%number</th><td>number</td></tr>		<tr><th>%number</th><td>number</td></tr>
	<tr><th>socket</th>		<tr><th>socket</th>
	<td>Socket object</td></tr>		<td>A variable or an expression that is a reference to a <var>Socket</var> object.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	==Examples==		==Examples==
	==See also==		==See also==
	{{Template:Socket:SSLOn footer}}		{{Template:Socket:SSLOn footer}}

JALWiccan: Automatically generated page update

2011-11-14T23:14:17Z

Automatically generated page update

New page

{{Template:Socket:SSLOn subtitle}}

This page is [[under construction]].
==Syntax==
{{Template:Socket:SSLOn syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%number</th><td>number</td></tr>
<tr><th>socket</th>
<td>Socket object</td></tr>
</table>
==Usage notes==
==Examples==
==See also==
{{Template:Socket:SSLOn footer}}