$Session Open - Revision history

JAL: misc cleanup

2015-10-06T22:48:41Z

misc cleanup

← Older revision		Revision as of 22:48, 6 October 2015
Line 2:		Line 2:
	<span class="pageSubtitle">Open a session</span>		<span class="pageSubtitle">Open a session</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Open function is <var>[[GetSession (Object subroutine)\|GetSession]]</var>.</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Open function is <var>[[GetSession (Object subroutine)\|GetSession]]</var>.</p>

	<var>$Session_Open</var> opens a previously created [[Sessions\|session]].		<var>$Session_Open</var> opens a previously created [[Sessions\|session]].


	==Syntax==		==Syntax==
Line 11:		Line 10:
	</p>		</p>

	<~~var~~>~~$Session_Open~~</~~var~~> ~~accepts three arguments and returns a~~ zero, indicating success, or a number indicating the cause of error, if there is one.		<table>
			<tr><th>%rc</th>
			<td>A returned zero, indicating success, or a number indicating the cause of error, if there is one.</td></tr>

	The ~~first argument is the id~~ of the session to be opened. This is a required argument.		<tr><th>sesid</th>
			<td>The ID of the session to be opened. This is a required argument.</td></tr>

	The ~~second argument is the~~ userid that owns the session to be opened. An <var class="term">owner</var> value of asterisk (<tt>*</tt>) means that the session is public, that is available to all users. This optional argument defaults to the creating user's userid.		<tr><th>owner</th>
			<td>The userid that owns the session to be opened. An <var class="term">owner</var> value of asterisk (<tt>*</tt>) means that the session is public, that is available to all users.
			<p>
			This optional argument defaults to the creating user's userid. </p></td></tr>

	The ~~third argument is the~~ time to wait for an in-use session to be closed before giving up. A value of -1 indicates to use the value of the ~~SRSDEFOW~~ parameter. This argument defaults to -1, that is the value of the ~~SRSDEFOW~~ parameter.		<tr><th>timeout</th>
			<td>The time to wait for an in-use session to be closed before giving up. A value of -1 indicates to use the value of the <var>[[SRSDEFTO parameter\|SRSDEFTO]]</var> parameter. This argument defaults to -1, that is, the value of the <var>SRSDEFTO</var> parameter.</td></tr>
			</table>

	===Return codes===		===Return codes===
Line 28:		Line 35:

	==Usage notes==		==Usage notes==
	Use of a non-zero timeout for <var>$Session_Open</var> can be useful for single-threading multiple threads through a request or for dealing with timing problems where it's possible for a request for a session to come in before the previous one is completely done. This is quite possible in <var class="product">[[Janus Web Server]]</var> applications where a request resulting from a redirect comes in before the redirecting thread has closed the session ~~or where a~~ user cancels a request and then resubmits it while the original request is still processing and so has the session open.		Use of a non-zero timeout for <var>$Session_Open</var> can be useful for single-threading multiple threads through a request or for dealing with timing problems where it's possible for a request for a session to come in before the previous one is completely done. This is quite possible in <var class="product">[[Janus Web Server]]</var> applications where one of these occurs:
			<ul>
			<li>A request resulting from a redirect comes in before the redirecting thread has closed the session</li>

			<li>A user cancels a request and then resubmits it while the original request is still processing and so has the session open.</li>
			</ul>

	==Example==		==Example==
	The following retrieves a session id from a cookie and opens it:		The following retrieves a session ID from a cookie and opens it:
	<p class="code">%~~SESID~~ = $~~WEB_GET_COOKIE~~('SESID')		<p class="code">%sesid = $Web_Get_Cookie('SESID')
	%RC = $Session_Open(%~~SESID~~)		%rc = $Session_Open(%sesid)
	</p>		</p>

JALWiccan: Automatically generated page update

2015-02-19T23:09:47Z

Automatically generated page update

← Older revision		Revision as of 23:09, 19 February 2015
Line 45:		Line 45:
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>
	</ul>		</ul>

	[[Category:$Functions\|$Session_Open]]		[[Category:$Functions\|$Session_Open]]

JALWiccan: Automatically generated page update

2015-02-19T22:58:40Z

Automatically generated page update

← Older revision		Revision as of 22:58, 19 February 2015
Line 45:		Line 45:
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/4/4b/~~SirfieldNew.pdf Sir2000 Field Migration Facility]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]</li>
	</ul>		</ul>

	[[Category:$Functions\|$Session_Open]]		[[Category:$Functions\|$Session_Open]]

JALWiccan: Automatically generated page update

2015-02-19T22:38:39Z

Automatically generated page update

← Older revision		Revision as of 22:38, 19 February 2015
Line 41:		Line 41:
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[[Media:JosrvrNew.pdf\|Janus Open Server]</li>		<li>[[Media:JosrvrNew.pdf\|Janus Open Server]]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>

JALWiccan: Automatically generated page update

2015-02-19T22:35:13Z

Automatically generated page update

← Older revision		Revision as of 22:35, 19 February 2015
Line 41:		Line 41:
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/1/17/~~JosrvrNew.pdf Janus Open Server]</li>		<li>[[Media:JosrvrNew.pdf\|Janus Open Server]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>

JALWiccan: Automatically generated page update

2015-02-19T21:21:37Z

Automatically generated page update

← Older revision		Revision as of 21:21, 19 February 2015
Line 40:		Line 40:
	<li>[[List of $functions\|Sirius functions]]</li>		<li>[[List of $functions\|Sirius functions]]</li>
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>		<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>

JALWiccan: Automatically generated page update

2015-02-19T21:17:59Z

Automatically generated page update

← Older revision		Revision as of 21:17, 19 February 2015
Line 40:		Line 40:
	<li>[[List of $functions\|Sirius functions]]</li>		<li>[[List of $functions\|Sirius functions]]</li>
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/4/4a/~~JoclrNew.pdf Janus Open Client]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]</li>
	<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>		<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>

JAL at 19:42, 12 August 2014

2014-08-12T19:42:05Z

← Older revision		Revision as of 19:42, 12 August 2014
Line 2:		Line 2:
	<span class="pageSubtitle">Open a session</span>		<span class="pageSubtitle">Open a session</span>

	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Open function is ~~'''~~[[~~to be entered~~]]~~'''~~.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $Session_Open function is <var>[[GetSession (Object subroutine)\|GetSession]]</var>.</p>

	<var>$Session_Open</var> opens a previously created [[Sessions\|session]], accepts three arguments and returns a zero, indicating success, or a number indicating the cause of error, if there is one.		<var>$Session_Open</var> opens a previously created [[Sessions\|session]].


			==Syntax==
			<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Session_Open</span>(<span class="term">sesid</span>, [<span class="term">owner</span>], [<span class="term">timeout</span>])
			</p>

			<var>$Session_Open</var> accepts three arguments and returns a zero, indicating success, or a number indicating the cause of error, if there is one.

	The first argument is the id of the session to be opened. This is a required argument.		The first argument is the id of the session to be opened. This is a required argument.

	The second argument is the userid that owns the session to be opened. An ~~'''~~owner~~'''~~ of "*" means that the session is public, that is available to all users. This optional argument defaults to the creating user's userid.		The second argument is the userid that owns the session to be opened. An <var class="term">owner</var> value of asterisk (<tt>*</tt>) means that the session is public, that is available to all users. This optional argument defaults to the creating user's userid.

	The third argument is the time to wait for an in-use session to be closed before giving up. A value of -1 indicates to use the value of the SRSDEFOW parameter. This argument defaults to -1, that is the value of the SRSDEFOW parameter.		The third argument is the time to wait for an in-use session to be closed before giving up. A value of -1 indicates to use the value of the SRSDEFOW parameter. This argument defaults to -1, that is the value of the SRSDEFOW parameter.
	~~==Syntax==~~
	~~<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Session_Open</span>(<span class="term">sesid</span>, [<span class="term">owner</span>], [<span class="term">timeout</span>])~~
	~~</p>~~

	===Return codes===		===Return codes===
Line 22:		Line 26:
	2 - Session in use		2 - Session in use
	</p>		</p>


	==Usage notes==		==Usage notes==

JALWiccan: Automatically generated page update

2014-08-01T22:08:21Z

Automatically generated page update

← Older revision		Revision as of 22:08, 1 August 2014
Line 35:		Line 35:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[Sirius functions]]</li>		<li>[[List of $functions\|Sirius functions]]</li>
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[http://m204wiki.rocketsoftware.com/images/4/4a/JoclrNew.pdf Janus Open Client]</li>		<li>[http://m204wiki.rocketsoftware.com/images/4/4a/JoclrNew.pdf Janus Open Client]</li>

JALWiccan: Automatically generated page update

2014-07-08T16:03:24Z

Automatically generated page update

← Older revision		Revision as of 16:03, 8 July 2014
Line 41:		Line 41:
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>[[Japanese functions]]</li>		<li>Japanese functions</li>
	<li>[http://m204wiki.rocketsoftware.com/images/4/4b/SirfieldNew.pdf Sir2000 Field Migration Facility]</li>		<li>[http://m204wiki.rocketsoftware.com/images/4/4b/SirfieldNew.pdf Sir2000 Field Migration Facility]</li>
	</ul>		</ul>

	[[Category:$Functions\|$Session_Open]]		[[Category:$Functions\|$Session_Open]]