Socket class - Revision history

JAL: add link

2016-02-02T20:22:53Z

add link

← Older revision		Revision as of 20:22, 2 February 2016
Line 50:		Line 50:

	If the connect fails, the object variable is set to null, and		If the connect fails, the object variable is set to null, and
	$~~Statusd~~ is set to what would be the return code value if		<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.

JAL at 23:29, 22 October 2013

2013-10-22T23:29:03Z

← Older revision		Revision as of 23:29, 22 October 2013
Line 5:		Line 5:
	Both client and server applications may be written using the <var>Socket</var> object.		Both client and server applications may be written using the <var>Socket</var> object.

	'''Note:'''		<p class="note">'''Note:'''
	To use the <var>Socket</var> object, you must have licensed <var class="product">Janus Sockets~~</var> '''and''' <var class="product">Janus SOAP~~</var>.		To use the <var>Socket</var> object, you must have licensed <var class="product">Janus Sockets</var>. </p>
	~~The Sirius object-oriented alternative to $functions is designed for~~
	~~<var class="product">Janus SOAP</var> applications only, and information about using Sirius objects is~~
	~~provided in <var class="product">[[Janus SOAP User Language Interface\|"Janus SOAP User Language Interface"]]~~</~~var~~>.

	There are some restrictions on the order in which the <var>Socket</var> object methods are		There are some restrictions on the order in which the <var>Socket</var> object methods are
Line 15:		Line 12:
	and data may not be sent after the FIN indicator is sent.		and data may not be sent after the FIN indicator is sent.
	For more information about <var class="product">Janus Sockets</var> programming,		For more information about <var class="product">Janus Sockets</var> programming,
	see [[Janus Sockets User Language coding considerations~~\|"Janus Sockets User Language coding considerations"~~]].		see [[Janus Sockets User Language coding considerations]].

	__TOC__		__TOC__
Line 24:		Line 21:
	with $Sock_xxx functions and socket numbers ("in peaceful coexistence").		with $Sock_xxx functions and socket numbers ("in peaceful coexistence").

	In the individual <var>Socket</var> method description pages (see [[List of Socket methods~~\|"List of Socket methods"~~]]),		In the individual <var>Socket</var> method description pages (see [[List of Socket methods]]),
	if a <var>Socket</var> method is described as equivalent to a $Sock_xxx function,		if a <var>Socket</var> method is described as equivalent to a $Sock_xxx function,
	the method has the same argument list as the $funtion, with one exception: the method has no socket number argument,		the method has the same argument list as the $funtion, with one exception: the method has no socket number argument,
Line 65:		Line 62:
	End If		End If
	</p>		</p>
	'''Note:''' An explicit <var>Discard</var> of the <var>Socket</var> object is not permitted.		<p class="note">'''Note:''' An explicit <var>Discard</var> of the <var>Socket</var> object is not permitted.
	You use the <var>[[Close (Socket function)\|Close]]</var> method		You use the <var>[[Close (Socket function)\|Close]]</var> method
	to close the socket and discard the <var>Socket</var> object.		to close the socket and discard the <var>Socket</var> object. </p>

	==List of Socket methods==		==List of Socket methods==
	The [[List of Socket methods~~\|"List of Socket methods"~~]] shows all the class methods.		The [[List of Socket methods]] shows all the class methods.

	==Sample code==		==Sample code==
	Here is a code fragment that fetches the Sirius home page using a <var>Socket</var> object.		Here is a code fragment that fetches the Sirius home page using a <var>Socket</var> object.
	You may want to contrast this with the $function sample in [[Sample Janus Sockets programs#Simple echo of HTTP/HTML\|"Simple echo of HTTP/HTML"]].		You may want to contrast this with the $function sample in [[Sample Janus Sockets programs#Simple echo of HTTP/HTML\|Simple echo of HTTP/HTML]].
	<p class="code">%socko object <var>Socket</var>		<p class="code">%socko object <var>Socket</var>
	%socko = New('HTTPCLIENT', 'www.sirius-software.com', 80)		%socko = New('HTTPCLIENT', 'www.sirius-software.com', 80)

JAL: /* See also */

2013-04-26T15:15:28Z

JAL at 19:07, 25 April 2013

2013-04-25T19:07:49Z

@@ Line 94: / Line 94: @@
 %socko:Close
 </p>
 [[Category:Janus Sockets]]

JAL2: /* List of Socket methods */

2012-06-11T19:31:40Z

List of Socket methods

@@ Line 71: / Line 71: @@
 ==List of Socket methods==
 The [[List of Socket methods|"List of Socket methods"]] shows all the class methods.
 [[Category:Janus Sockets]]

JAL2 at 23:09, 14 February 2012

2012-02-14T23:09:45Z

← Older revision		Revision as of 23:09, 14 February 2012
Line 1:		Line 1:
	The <var>Socket</var> object is a coding alternative to using the $~~Sock_xxxx~~ functions.		The <var>Socket</var> object is a coding alternative to using the [[Janus Sockets $functions]].
	An application written with the <var>Socket</var> object does not need to manage or refer to socket numbers.		An application written with the <var>Socket</var> object does not need to manage or refer to socket numbers.
	An instance of a <var>Socket</var>		An instance of a <var>Socket</var>

JAL2: /* Creating and destroying Socket objects */

2012-01-20T20:32:39Z

Creating and destroying Socket objects

← Older revision		Revision as of 20:32, 20 January 2012
Line 40:		Line 40:

	==Creating and destroying Socket objects==		==Creating and destroying Socket objects==
	The <var>Socket</var> object constructor, the <var>[[New (Socket ~~function~~)\|New]]</var> method,		The <var>Socket</var> object constructor, the <var>[[New (Socket constructor)\|New]]</var> method,
	creates an instance of a <var>Socket</var> object.		creates an instance of a <var>Socket</var> object.
	The object created with <var>New</var> is a reference to		The object created with <var>New</var> is a reference to

JAL2 at 00:17, 24 December 2011

2011-12-24T00:17:28Z

← Older revision		Revision as of 00:17, 24 December 2011
Line 1:		Line 1:
	The <var>Socket</var> object is a coding alternative to using the $Sock_xxxx		The <var>Socket</var> object is a coding alternative to using the $Sock_xxxx functions.
	functions.		An application written with the <var>Socket</var> object does not need to manage or refer to socket numbers.
	An application written with the <var>Socket</var> object does not
	need to manage or refer to socket numbers.
	An instance of a <var>Socket</var>		An instance of a <var>Socket</var>
	is essentially an object style reference to a <var>Socket</var> number.		is essentially an object style reference to a <var>Socket</var> number.
	Both client and server applications may be written using the <var>Socket</var>		Both client and server applications may be written using the <var>Socket</var> object.
	object.

	'''Note:'''		'''Note:'''
Line 14:		Line 11:
	provided in <var class="product">[[Janus SOAP User Language Interface\|"Janus SOAP User Language Interface"]]</var>.		provided in <var class="product">[[Janus SOAP User Language Interface\|"Janus SOAP User Language Interface"]]</var>.

	~~This article is primarily concerned with how to use~~ the ~~individual~~		There are some restrictions on the order in which the <var>Socket</var> object methods are
	<var>Socket</var> object ~~methods.~~
	~~There are some restrictions on the order in which the~~ methods are
	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 FIN indicator is sent.		and data may not be sent after the FIN indicator is sent.
Line 22:		Line 17:
	see [[Janus Sockets User Language coding considerations\|"Janus Sockets User Language coding considerations"]].		see [[Janus Sockets User Language coding considerations\|"Janus Sockets User Language coding considerations"]].

			__TOC__

			==Using Socket methods and $Sock_xxx functions==
	Most of the <var>Socket</var> methods have analogous $functions,		Most of the <var>Socket</var> methods have analogous $functions,
	and <var>Socket</var> objects may be used in code intermixed		and <var>Socket</var> objects may be used in code intermixed
	with $Sock_xxx functions and socket numbers ("in peaceful coexistence").		with $Sock_xxx functions and socket numbers ("in peaceful coexistence").

	In the individual <var>Socket</var> method description pages (see [[List of Socket methods]]),		In the individual <var>Socket</var> method description pages (see [[List of Socket methods\|"List of Socket methods"]]),
	if a <var>Socket</var> method is described as equivalent to a $Sock_xxx function,		if a <var>Socket</var> method is described as equivalent to a $Sock_xxx function,
	the method has the same argument list as the $funtion, with one exception: the method has no socket number argument,		the method has the same argument list as the $funtion, with one exception: the method has no socket number argument,
Line 70:		Line 68:
	You use the <var>[[Close (Socket function)\|Close]]</var> method		You use the <var>[[Close (Socket function)\|Close]]</var> method
	to close the socket and discard the <var>Socket</var> object.		to close the socket and discard the <var>Socket</var> object.

			==List of Socket methods==
			The [[List of Socket methods\|"List of Socket methods"]] shows all the class methods.

	[[Category:Janus Sockets]]		[[Category:Janus Sockets]]

JAL2 at 20:06, 7 November 2011

2011-11-07T20:06:36Z

← Older revision		Revision as of 20:06, 7 November 2011
Line 12:		Line 12:
	The Sirius object-oriented alternative to $functions is designed for		The Sirius object-oriented alternative to $functions is designed for
	<var class="product">Janus SOAP</var> applications only, and information about using Sirius objects is		<var class="product">Janus SOAP</var> applications only, and information about using Sirius objects is
	provided in ~~the~~ <var class="product">[[Janus SOAP User Language Interface\|"Janus SOAP User Language Interface"]]</var>.		provided in <var class="product">[[Janus SOAP User Language Interface\|"Janus SOAP User Language Interface"]]</var>.

	This article is primarily concerned with how to use the individual		This article is primarily concerned with how to use the individual
Line 33:		Line 33:
	To simplify the conversion of existing <var class="product">Janus Sockets</var> code, two transition methods		To simplify the conversion of existing <var class="product">Janus Sockets</var> code, two transition methods
	are provided:		are provided:
	<var>[[GetSocketNumber (Socket function\|GetSocketNumber]]</var>)		<ul>
	gives the socket number for an object instance;		<li><var>[[GetSocketNumber (Socket function)\|GetSocketNumber]]</var>
	<var>[[GetSocketObject (Socket function\|GetSocketObject]]</var>)		gives the socket number for an object instance.
			<li><var>[[GetSocketObject (Socket function)\|GetSocketObject]]</var>
	creates an object instance for a given socket number.		creates an object instance for a given socket number.
	These transition methods let		</ul>
	you gradually convert an existing application to use <var>Socket</var> objects.		These transition methods let you gradually convert an existing application to use <var>Socket</var> objects.

	==Creating and destroying Socket objects==		==Creating and destroying Socket objects==
Line 66:		Line 67:
	End If		End If
	</p>		</p>
	:~~Note.~~		'''Note:''' An explicit <var>Discard</var> of the <var>Socket</var> object is not permitted.
	An explicit <var>Discard</var> of the <var>Socket</var> object is not permitted.
	You use the <var>[[Close (Socket function)\|Close]]</var> method		You use the <var>[[Close (Socket function)\|Close]]</var> method
	to close the socket and discard the <var>Socket</var> object.		to close the socket and discard the <var>Socket</var> object.

	[[Category:Janus Sockets]]		[[Category:Janus Sockets]]

JAL2: Created page with "The `Socket` object is a coding alternative to using the $Sock_xxxx functions. An application written with the `Socket` object does not need to manage or refer ..."

2011-11-07T20:00:26Z

Created page with "The <var>Socket</var> object is a coding alternative to using the $Sock_xxxx functions. An application written with the <var>Socket</var> object does not need to manage or refer ..."

New page

The <var>Socket</var> object is a coding alternative to using the $Sock_xxxx
functions.
An application written with the <var>Socket</var> object does not
need to manage or refer to socket numbers.
An instance of a <var>Socket</var>
is essentially an object style reference to a <var>Socket</var> number.
Both client and server applications may be written using the <var>Socket</var>
object.

'''Note:'''
To use the <var>Socket</var> object, you must have licensed <var class="product">Janus Sockets</var> '''and''' <var class="product">Janus SOAP</var>.
The Sirius object-oriented alternative to $functions is designed for
<var class="product">Janus SOAP</var> applications only, and information about using Sirius objects is
provided in the <var class="product">[[Janus SOAP User Language Interface|"Janus SOAP User Language Interface"]]</var>.

This article is primarily concerned with how to use the individual
<var>Socket</var> object methods.
There are some restrictions on the order in which the methods are
used: for example, a socket port must be connected before data is sent using it,
and data may not be sent after the FIN 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"]].

Most of the <var>Socket</var> methods have analogous $functions,
and <var>Socket</var> objects may be used in code intermixed
with $Sock_xxx functions and socket numbers ("in peaceful coexistence").

In the individual <var>Socket</var> method description pages (see [[List of Socket methods]]),
if a <var>Socket</var> method is described as equivalent to a $Sock_xxx function,
the method has the same argument list as the $funtion, with one exception: the method has no socket number argument,
since the socket is implied by the object instance.

To simplify the conversion of existing <var class="product">Janus Sockets</var> code, two transition methods
are provided:
<var>[[GetSocketNumber (Socket function|GetSocketNumber]]</var>)
gives the socket number for an object instance;
<var>[[GetSocketObject (Socket function|GetSocketObject]]</var>)
creates an object instance for a given socket number.
These transition methods let
you gradually convert an existing application to use <var>Socket</var> objects.

==Creating and destroying Socket objects==
The <var>Socket</var> object constructor, the <var>[[New (Socket function)|New]]</var> method,
creates an instance of a <var>Socket</var> object.
The object created with <var>New</var> is a reference to
a connection to a remote host using a Janus client socket.
The <var>[[ServerSocket (Socket function)|ServerSocket]]</var> method
obtains a reference to a <var>Socket</var> object for a server socket.

The following is an example of the <var>New</var> constructor:
<p class="code">%socko is object <var>Socket</var>
%socko = New(clientportname, host, port [, ssl])
</p>

If the connect fails, the object variable is set to null, and
$Statusd 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
that creates a socket connection.

To obtain information about any errors that occur while attempting to construct
a <var>Socket</var> object instance,
here is an error handler that can be used after the <var>New</var> constructor:
<p class="code">If %socko Is Null Then
Print 'Error:' And $Statusd
Stop
End If
</p>
:Note.
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.

[[Category:Janus Sockets]]

← Older revision		Revision as of 15:15, 26 April 2013
Line 97:		Line 97:
	==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: