Global and session objects - Revision history

JAL: misc formatting

2017-07-11T19:32:42Z

misc formatting

← Older revision		Revision as of 19:32, 11 July 2017
Line 6:		Line 6:
	span requests.		span requests.

	In <var class="product">SOUL</var>, there are two kinds of objects that span requests:		In <var class="product">SOUL</var>, there are two kinds of objects that span requests: '''global objects''' and '''session objects'''.
	'''global objects''' and '''session objects'''.
	Like object variables, global and session objects are not really objects but		Like object variables, global and session objects are not really objects but
	references to the underlying objects.		references to the underlying objects.

	A global or session object is referenced by its name (any 1- to 255-byte string),		A global or session object is referenced by its name (any 1- to 255-byte string), which is kept in a table in CCATEMP that is not cleaned up at
	which is kept in a table in CCATEMP that is not cleaned up at
	the end of request.		the end of request.
	Since a global/session name allows an underlying object to be referenced		Since a global/session name allows an underlying object to be referenced
Line 62:		Line 60:
	the variable <code>%larry</code> is to be bound to the session		the variable <code>%larry</code> is to be bound to the session
	name <code>LARRY</code>.		name <code>LARRY</code>.
	This means that, on the first reference to %moe in the request,		This means that, on the first reference to <code>%moe</code> in the request,
	the global name MOE is looked up in the global object		the global name <code>MOE</code> is looked up in the global object
	table and, if present, assigned to %moe.		table and, if present, assigned to <code>%moe</code>.
	If the name MOE is not found in the global object table,		If the name <code>MOE</code> is not found in the global object table,
	%moe is left as null, its initial value.		<code>%moe</code> is left as null, its initial value.
	After that first reference, any changes to %moe are reflected		After that first reference, any changes to <code>%moe</code> are reflected
	in the global object.		in the global object.
	Similar processing occurs for variable %larry with the differences that
			Similar processing occurs for variable <code>%larry</code>, with the differences that
	lookup for the session name is done in the session object table, and if		lookup for the session name is done in the session object table, and if
	no session is open, the first reference is a request cancelling error.		no session is open, the first reference is a request cancelling error.
Line 215:		Line 214:
	are accessed in all those requests via a global or session name.		are accessed in all those requests via a global or session name.

	A file or group object (see [[File classes~~\|"File classes"~~]]) associated with a global/session		A file or group object (see [[File classes]]) associated with a global/session name will be implicitly discarded if the file or group is closed between requests.
	name will be implicitly discarded if the file or group is closed between
	requests.

	==Using system class methods to access global and session objects==		==Using system class methods to access global and session objects==
Line 699:		Line 696:
	==See also==		==See also==
	<ul>		<ul>
	<li>[[Sessions]]		<li>[[Sessions]] </li>
	<li>[[Classes and Objects]]		<li>[[Classes and Objects]] </li>
	<li>[[Object variables]]		<li>[[Object variables]] </li>
	<li>[[Copying objects]]		<li>[[Copying objects]] </li>
	<li>[[Managing server space for objects]]		<li>[[Managing server space for objects]] </li>
	<li>[[Object oriented programming in SOUL]]		<li>[[Object oriented programming in SOUL]] </li>
	<li>The [[#globObjMeths\|list of global-related]] methods in the <var>Object</var> class.		<li>The [[#globObjMeths\|list of global-related]] methods in the <var>Object</var> class </li>
	</ul>		</ul>

	[[Category:SOUL object-oriented programming topics]]		[[Category:SOUL object-oriented programming topics]]

Dme: /* Using the Object class */

2015-11-03T19:23:41Z

Using the Object class

← Older revision		Revision as of 19:23, 3 November 2015
Line 221:		Line 221:
	==Using system class methods to access global and session objects==		==Using system class methods to access global and session objects==

	===Using the Object class===		===<b id="globObjMeths"></b>Using the Object class===
	In addition to binding to a variable, the other way to access global/session names		In addition to binding to a variable, the other way to access global/session names
	is to use shared methods in the <var>[[Object class\|Object]]</var> class.		is to use shared methods in the <var>[[Object class\|Object]]</var> class.

Dme: /* See also */

2015-11-03T19:22:55Z

JAL at 19:37, 27 August 2014

2014-08-27T19:37:28Z

@@ Line 270: / Line 270: @@
 </table>
 </div>
 The following code illustrates how globals are set:

JAL at 22:44, 8 August 2014

2014-08-08T22:44:17Z

← Older revision		Revision as of 22:44, 8 August 2014
Line 1:		Line 1:
	Object %variables are useful for holding references to objects in a request.		Object %variables are useful for holding references to objects in a request.
	However, these references ~~“~~go away~~”~~ at the end of a request.		However, these references "go away" at the end of a request.
	But it		But it can be very useful to have objects that can be used in multiple <var class="product">SOUL</var>
	can be very useful to have objects that can be used in multiple <var class="product">SOUL</var>
	requests, that is, in multiple procedure evaluations.		requests, that is, in multiple procedure evaluations.
	For this to be possible, references to objects must be able to		For this to be possible, references to objects must be able to
Line 39:		Line 38:
	The global and session namespaces are completely separate:		The global and session namespaces are completely separate:
	it is perfectly valid to have a session object reference called		it is perfectly valid to have a session object reference called
	~~“~~HAL~~”~~ and a global object reference with the same name.		"HAL" and a global object reference with the same name.
	These references could be to the same underlying object or, more likely,		These references could be to the same underlying object or, more likely,
	could be references to two totally separate objects, even in different classes.		could be references to two totally separate objects, even in different classes.
Line 49:		Line 48:
	You can access an object through its global/session name by:		You can access an object through its global/session name by:
	<ul>		<ul>
	<li>A static compile-time binding of the name to a variable		<li>A static compile-time binding of the name to a variable </li>
	<li>A dynamic run-time request for a global/session name		<li>A dynamic run-time request for a global/session name </li>
	</ul>		</ul>

	==Binding global/session names to a variable==		==Binding global/session names to a variable==
	The simplest way to use a global name is to bind a variable to it:		The simplest way to use a global name is to bind a variable to it:
Line 136:		Line 136:
	<ul>		<ul>
	<li>Anything about methods.		<li>Anything about methods.
	This includes their absence or presence, parameters, and code.		This includes their absence or presence, parameters, and code. </li>
	<li>Public and private shared variables.		<li>Public and private shared variables. </li>
	<li>The names of any variables.		<li>The names of any variables. </li>
	</ul>		</ul>

Line 218:		Line 218:
	name will be implicitly discarded if the file or group is closed between		name will be implicitly discarded if the file or group is closed between
	requests.		requests.

	==Using system class methods to access global and session objects==		==Using system class methods to access global and session objects==

	===Using the Object class===		===Using the Object class===
	In addition to binding to a variable, the other way to access global/session names		In addition to binding to a variable, the other way to access global/session names
Line 235:		Line 237:

	The following shared methods are available for the <var>Object</var> class:		The following shared methods are available for the <var>Object</var> class:

			<div class="showVisit">
			<table class="wikitable">
			<tr class="head"><th>Method</th><th>Description</th></tr>
			<tr><td valign="top">[[DiscardGlobal (Object subroutine)\|DiscardGlobal]]</td><td valign="top">Discard a global object</td></tr>

			<tr><td valign="top">[[DiscardGlobals (Object subroutine)\|DiscardGlobals]]</td><td valign="top">Discard global objects</td></tr>

			<tr><td valign="top">[[DiscardSession (Object subroutine)\|DiscardSession]]</td><td valign="top">Discard a session object</td></tr>

			<tr><td valign="top">[[DiscardSessions (Object subroutine)\|DiscardSessions]]</td><td valign="top">Discard session objects</td></tr>

			<tr><td valign="top">[[GetGlobal (Object subroutine)\|GetGlobal]]</td><td valign="top">Retrieve global object reference</td></tr>

			<tr><td valign="top">[[GetSession (Object subroutine)\|GetSession]]</td><td valign="top">Retrieve session object reference</td></tr>

			<tr><td valign="top">[[GlobalList (Object function)\|GlobalList]]</td><td valign="top">Get list of global objects</td></tr>

			<tr><td valign="top">[[NullifyGlobal (Object subroutine)\|NullifyGlobal]]</td><td valign="top">Clear global object reference</td></tr>

			<tr><td valign="top">[[NullifyGlobals (Object subroutine)\|NullifyGlobals]]</td><td valign="top">Clear global object references</td></tr>

			<tr><td valign="top">[[NullifySession (Object subroutine)\|NullifySession]]</td><td valign="top">Clear session object reference</td></tr>

			<tr><td valign="top">[[NullifySessions (Object subroutine)\|NullifySessions]]</td><td valign="top">Clear global object references</td></tr>

			<tr><td valign="top">[[SessionList (Object function)\|SessionList]]</td><td valign="top">Get list of session objects</td></tr>

			<tr><td valign="top">[[SetGlobal (Object subroutine)\|SetGlobal]]</td><td valign="top">Set global object reference</td></tr>

			<tr><td valign="top">[[SetSession (Object subroutine)\|SetSession]]</td><td valign="top">Set session object reference</td></tr>
			</table>
			</div>


	<table>		<table>
	<tr><th><var>DiscardGlobal</var>		<tr><th><var>[[DiscardGlobal (Object subroutine)\|DiscardGlobal]]</var>
	</th><td><p class="code">%(Object):DiscardGlobal(<i>name</i>)</p>		</th><td><p class="code">%(Object):DiscardGlobal(<i>name</i>)</p>

Line 329:		Line 366:
	</table>		</table>

	The following code illustrates how ~~two~~ globals are set:		The following code illustrates how globals are set:
	<p class="code">%moe is class stooge		<p class="code">%moe is class stooge
	%larry is class stooge		%larry is class stooge

JAL: /* Using the Object class */

2014-08-06T22:24:13Z

Using the Object class

← Older revision		Revision as of 22:24, 6 August 2014
Line 221:		Line 221:
	===Using the Object class===		===Using the Object class===
	In addition to binding to a variable, the other way to access global/session names		In addition to binding to a variable, the other way to access global/session names
	is to use shared methods in the <var>Object</var> class.		is to use shared methods in the <var>[[Object class\|Object]]</var> class.
	The <var>Object</var> class can be thought of us the base class for all objects.		The <var>Object</var> class can be thought of us the base class for all objects.
	It is possible to define an object in the <var>Object</var> class:		It is possible to define an object in the <var>Object</var> class:

JAL at 17:32, 22 October 2013

2013-10-22T17:32:50Z

Show changes

JAL: /* See also */

2013-10-14T22:14:16Z

JAL at 19:46, 14 October 2013

2013-10-14T19:46:20Z

← Older revision		Revision as of 19:46, 14 October 2013
Line 752:		Line 752:
	</ul>		</ul>

	[[Category:~~Janus SOAP ULI~~ topics]]		[[Category:SOUL object-oriented programming topics]]

JAL: /* Explicitly discarding */

2013-07-25T21:29:41Z

Explicitly discarding

← Older revision		Revision as of 21:29, 25 July 2013
Line 610:		Line 610:
	It is sometimes sufficient to explicitly discard a single		It is sometimes sufficient to explicitly discard a single
	object in an about-to-be-orphaned cycle to discard the whole cycle.		object in an about-to-be-orphaned cycle to discard the whole cycle.
	If in the [[Cycle example\|cycle example]], you specified		If in the [[#Cycle example\|cycle example]], you specified
	<p class="code">%a:discard		<p class="code">%a:discard
	</p>		</p>
Line 622:		Line 622:
	<p class="code">%a:deepdiscard		<p class="code">%a:deepdiscard
	</p>		</p>

	====Invoking garbage collection====		====Invoking garbage collection====

← Older revision		Revision as of 19:22, 3 November 2015
Line 705:		Line 705:
	<li>[[Managing server space for objects]]		<li>[[Managing server space for objects]]
	<li>[[Object oriented programming in SOUL]]		<li>[[Object oriented programming in SOUL]]
			<li>The [[#globObjMeths\|list of global-related]] methods in the <var>Object</var> class.
	</ul>		</ul>

	[[Category:SOUL object-oriented programming topics]]		[[Category:SOUL object-oriented programming topics]]

← Older revision		Revision as of 22:14, 14 October 2013
Line 749:		Line 749:
	<li>[[Copying objects]]		<li>[[Copying objects]]
	<li>[[Managing server space for objects]]		<li>[[Managing server space for objects]]
	<li>[[~~Janus SOAP ULI essentials~~]]		<li>[[Object oriented programming in SOUL]]
	</ul>		</ul>

	[[Category:SOUL object-oriented programming topics]]		[[Category:SOUL object-oriented programming topics]]