$CommBg - Revision history

DCameron at 15:03, 15 November 2018

2018-11-15T15:03:53Z

← Older revision		Revision as of 15:03, 15 November 2018
Line 79:		Line 79:
	end		end
	</p>		</p>

			==Products authorizing {{PAGENAMEE}}==
			<ul class="smallAndTightList">
			<li>[[Janus Sockets]]</li>
			<li>[[Janus Web Server]]</li>

			</ul>

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

JAL: link repair

2018-02-07T18:45:00Z

link repair

← Older revision		Revision as of 18:45, 7 February 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Execute Model 204 commands on sdaemon</span>		<span class="pageSubtitle">Execute Model 204 commands on sdaemon</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $CommBg function is [[Run (Daemon function)\|Run]]. The OO APIs emphasize the use of the [[List of Daemon methods\|Daemon methods]]; users are strongly urged to use the new Daemon API instead of the old $functions.</p>		<p class="warn"><b>Note:</b> Many $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the <var>$CommBg</var> function is [[Run (Daemon function)\|Run]]. The OO APIs emphasize the use of the [[List of Daemon methods\|Daemon methods]]; users are strongly urged to use the new Daemon API instead of the old $functions.</p>

	This function allows one or more <var class="product">Model 204</var> commands to be executed on an [[Sdaemons\|sdaemon]]. It has two basic modes of operation:		This function allows one or more <var class="product">Model 204</var> commands to be executed on an [[Sdaemons\|sdaemon]]. It has two basic modes of operation:

	<ul>		<ul>
	<li>"asynchronous" mode is used when the output from the <var class="product">Model 204</var> commands are not to be returned into a $list. This is indicated by the absence of the fourth parameter (the output $list identifier). When a request is initiated in "asynchronous" mode, <var>$CommBg</var> returns immediately, before the commands in the input $list are executed.		<li>"asynchronous" mode is used when the output from the <var class="product">Model 204</var> commands are not to be returned into a $list. This is indicated by the absence of the fourth parameter (the output $list identifier). When a request is initiated in "asynchronous" mode, <var>$CommBg</var> returns immediately, before the commands in the input $list are executed. </li>
	<li>"synchronous" mode is used when the output from the <var class="product">Model 204</var> commands are to be returned into a $list. When a request is initiated in "synchronous" mode, <var>$CommBg</var> does not return until all commands in the input $list have been executed.
			<li>"synchronous" mode is used when the output from the <var class="product">Model 204</var> commands are to be returned into a $list. When a request is initiated in "synchronous" mode, <var>$CommBg</var> does not return until all commands in the input $list have been executed. </li>
	</ul>		</ul>

Line 23:		Line 24:
	===Syntax terrms===		===Syntax terrms===
	<tr><th>inlist</th>		<tr><th>inlist</th>
	<td>The identifier of a $list that contains the <var class="product">Model 204</var> commands to be executed in the sdaemon. If the request is an "asynchronous" request (<var class="term">outlist</var> argument missing), the contents of this $list are passed to the sdaemon, and they become no longer available to the invoking program. This is a required argument. After execution of <var>$CommBg</var>, this list is empty.</td></tr>		<td>The identifier of a $list that contains the <var class="product">Model 204</var> commands to be executed in the sdaemon. If the request is an "asynchronous" request (<var class="term">outlist</var> argument missing), the contents of this $list are passed to the sdaemon, and they become no longer available to the invoking program. This is a required argument. After execution of <var>$CommBg</var>, this list is empty.</td></tr>

	<tr><th>file</th>		<tr><th>file</th>
Line 32:		Line 33:

	<tr><th>outlist</th>		<tr><th>outlist</th>
	<td>The identifier of a $list to receive the printed output from the <var class="product">Model 204</var> commands in the input $list. If this optional argument is present, <var>$CommBg</var> works in "synchronous" mode: it does not return until all the <var class="product">Model 204</var>. commands in the input $list have been executed. If this argument is not present, <var>$CommBg</var> works in "asynchronous" mode: it returns before any of the <var class="product">Model 204</var> commands in the input $list are executed, and the output lines of the background task are placed on the audit trail as "AD" lines. The output line width is set to the minimum <var>[[~~LOBUFF_parameter~~\|LOBUFF]]</var> value for any sdaemon thread in the Online.</td></tr>		<td>The identifier of a $list to receive the printed output from the <var class="product">Model 204</var> commands in the input $list. If this optional argument is present, <var>$CommBg</var> works in "synchronous" mode: it does not return until all the <var class="product">Model 204</var>. commands in the input $list have been executed. If this argument is not present, <var>$CommBg</var> works in "asynchronous" mode: it returns before any of the <var class="product">Model 204</var> commands in the input $list are executed, and the output lines of the background task are placed on the audit trail as "AD" lines. The output line width is set to the minimum <var>[[LOBUFF parameter\|LOBUFF]]</var> value for any sdaemon thread in the Online.</td></tr>

	<tr><th>msgctl</th>		<tr><th>msgctl</th>
	<td>A number indicating the setting to be used for <var>[[~~MSGCTL_parameter~~\|MSGCTL]]</var> when running the commands in the sdaemon. This is an optional parameter, and it defaults to the user's current MSGCTL setting.		<td>A number indicating the setting to be used for <var>[[MSGCTL parameter\|MSGCTL]]</var> when running the commands in the sdaemon. This is an optional parameter, and it defaults to the user's current <var>MSGCTL</var> setting. </td></tr>
	</td></tr>
	</table>		</table>

Line 48:		Line 48:
	16 - No sdaemons are running		16 - No sdaemons are running
	20 - Out of storage		20 - Out of storage
	24 - Output $list or [[~~Using_the_system_scratch_file_~~(CCATEMP)\|CCATEMP]] full (synchronous only)		24 - Output $list or [[Using the system scratch file (CCATEMP)\|CCATEMP]] full (synchronous only)
	40 - Invalid file identifier		40 - Invalid file identifier
	</p>		</p>

DCameron: /* Return codes */

2018-02-06T15:55:53Z

Return codes

← Older revision		Revision as of 15:55, 6 February 2018
Line 48:		Line 48:
	16 - No sdaemons are running		16 - No sdaemons are running
	20 - Out of storage		20 - Out of storage
	24 - Output $list or CCATEMP full (synchronous only)		24 - Output $list or [[Using_the_system_scratch_file_(CCATEMP)\|CCATEMP]] full (synchronous only)
	40 - Invalid file identifier		40 - Invalid file identifier
	</p>		</p>

DCameron: /* Syntax terrms */

2018-02-06T15:42:40Z

Syntax terrms

← Older revision		Revision as of 15:42, 6 February 2018
Line 35:		Line 35:

	<tr><th>msgctl</th>		<tr><th>msgctl</th>
	<td>A number indicating the setting to be used for MSGCTL when running the commands in the sdaemon. This is an optional parameter, and it defaults to the user's current MSGCTL setting.		<td>A number indicating the setting to be used for <var>[[MSGCTL_parameter\|MSGCTL]]</var> when running the commands in the sdaemon. This is an optional parameter, and it defaults to the user's current MSGCTL setting.
	</td></tr>		</td></tr>
	</table>		</table>

DCameron: /* Syntax terrms */

2018-02-06T15:41:31Z

Syntax terrms

← Older revision		Revision as of 15:41, 6 February 2018
Line 32:		Line 32:

	<tr><th>outlist</th>		<tr><th>outlist</th>
	<td>The identifier of a $list to receive the printed output from the <var class="product">Model 204</var> commands in the input $list. If this optional argument is present, <var>$CommBg</var> works in "synchronous" mode: it does not return until all the <var class="product">Model 204</var>. commands in the input $list have been executed. If this argument is not present, <var>$CommBg</var> works in "asynchronous" mode: it returns before any of the <var class="product">Model 204</var> commands in the input $list are executed, and the output lines of the background task are placed on the audit trail as "AD" lines. The output line width is set to the minimum <var>LOBUFF</var> value for any sdaemon thread in the Online.</td></tr>		<td>The identifier of a $list to receive the printed output from the <var class="product">Model 204</var> commands in the input $list. If this optional argument is present, <var>$CommBg</var> works in "synchronous" mode: it does not return until all the <var class="product">Model 204</var>. commands in the input $list have been executed. If this argument is not present, <var>$CommBg</var> works in "asynchronous" mode: it returns before any of the <var class="product">Model 204</var> commands in the input $list are executed, and the output lines of the background task are placed on the audit trail as "AD" lines. The output line width is set to the minimum <var>[[LOBUFF_parameter\|LOBUFF]]</var> value for any sdaemon thread in the Online.</td></tr>

	<tr><th>msgctl</th>		<tr><th>msgctl</th>

DCameron at 15:53, 5 February 2018

2018-02-05T15:53:41Z

← Older revision		Revision as of 15:53, 5 February 2018
Line 4:		Line 4:
	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $CommBg function is [[Run (Daemon function)\|Run]]. The OO APIs emphasize the use of the [[List of Daemon methods\|Daemon methods]]; users are strongly urged to use the new Daemon API instead of the old $functions.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $CommBg function is [[Run (Daemon function)\|Run]]. The OO APIs emphasize the use of the [[List of Daemon methods\|Daemon methods]]; users are strongly urged to use the new Daemon API instead of the old $functions.</p>

	This function allows one or more <var class="product">Model 204</var> commands to be executed on an sdaemon. It has two basic modes of operation:		This function allows one or more <var class="product">Model 204</var> commands to be executed on an [[Sdaemons\|sdaemon]]. It has two basic modes of operation:

	<ul>		<ul>

JAL: fix consecutive single quotes

2014-11-12T16:11:05Z

fix consecutive single quotes

← Older revision		Revision as of 16:11, 12 November 2014
Line 54:		Line 54:
	==Example==		==Example==
	The following program does a PAI dump of file <code>COMPSON</code> in an sdaemon:		The following program does a PAI dump of file <code>COMPSON</code> in an sdaemon:
	<p class="code">B		<p class="code">b
	%~~LIST~~ = $ListNew		%list = $ListNew
	%RC = $ListAdd(%~~LIST~~, 'USE OUTFILE')		%rc = $ListAdd(%list, 'USE OUTFILE')
	%RC = $ListAdd(%~~LIST~~, 'B')		%rc = $ListAdd(%list, 'B')
	%RC = $ListAdd(%~~LIST~~, 'FOR EACH RECORD')		%rc = $ListAdd(%list, 'FOR EACH RECORD')
	%RC = $ListAdd(%~~LIST~~, ' PRINT ''*''')		%rc = $ListAdd(%list, ' PRINT ''*''')
	%RC = $ListAdd(%~~LIST~~, ' PAI')		%rc = $ListAdd(%list, ' PAI')
	%RC = $ListAdd(%~~LIST~~, 'END FOR')		%rc = $ListAdd(%list, 'END FOR')
	%RC = $ListAdd(%~~LIST~~, 'END')		%rc = $ListAdd(%list, 'END')

	%RC = $CommBg(%~~LIST~~, 'COMPSON', 'PAI UNLOAD')		%rc = $CommBg(%list, 'COMPSON', 'PAI UNLOAD')
	~~END~~		end
	</p>		</p>

	The following program creates a permanent group called <code>SNOPES</code> and then opens that group:		The following program creates a permanent group called <code>SNOPES</code> and then opens that group:
	<p class="code">B		<p class="code">b
	%~~ILIST~~ = $ListNew		%ilist = $ListNew
	%~~OLIST~~ = $ListNew		%olist = $ListNew
	%RC = $ListAdd(%~~ILIST~~, -		%rc = $ListAdd(%ilist, 'CREATE PERM GROUP SNOPES FROM FLEM,IKE')
	'CREATE PERM GROUP SNOPES FROM FLEM,IKE')		%rc = $ListAdd(%ilist, 'PARAMETER PROCFILE=*')
	%RC = $ListAdd(%~~ILIST~~, 'PARAMETER PROCFILE=*')		%rc = $ListAdd(%ilist, 'END')
	%RC = $ListAdd(%~~ILIST~~, 'END')		%rc = $CommBg(%ilist, , ,%olist)
	%RC = $CommBg(%~~ILIST~~, , ,%~~OLIST~~)
	OPEN PERM GROUP SNOPES		OPEN PERM GROUP SNOPES
	~~END~~		end
	</p>		</p>


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

ELowell at 23:14, 11 November 2014

2014-11-11T23:14:18Z

← Older revision		Revision as of 23:14, 11 November 2014
Line 26:		Line 26:

	<tr><th>file</th>		<tr><th>file</th>
	<td>A string indicating the name of a file that is to be automatically opened by the sdaemon and made the current file before commands in ~~'''~~inlist~~'''~~ are executed. This file is opened with the same access privileges the user currently has for the file. This is an optional parameter.</td></tr>		<td>A string indicating the name of a file that is to be automatically opened by the sdaemon and made the current file before commands in <strong><i>inlist</i></strong> are executed. This file is opened with the same access privileges the user currently has for the file. This is an optional parameter.</td></tr>

	<tr><th>descriptor</th>		<tr><th>descriptor</th>

JAL at 20:33, 18 July 2013

2013-07-18T20:33:16Z

← Older revision		Revision as of 20:33, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Execute Model 204 commands on sdaemon</span>		<span class="pageSubtitle">Execute Model 204 commands on sdaemon</span>

	<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $CommBg function is [[Run (Daemon function)]]. The OO APIs emphasize the use of the [[List of Daemon methods\|Daemon methods]]; users are strongly urged to use the new Daemon API instead of the old $functions.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $CommBg function is [[Run (Daemon function)\|Run]]. The OO APIs emphasize the use of the [[List of Daemon methods\|Daemon methods]]; users are strongly urged to use the new Daemon API instead of the old $functions.</p>

	This function allows one or more <var class="product">Model 204</var> commands to be executed on an sdaemon. It has two basic modes of operation:		This function allows one or more <var class="product">Model 204</var> commands to be executed on an sdaemon. It has two basic modes of operation:

JALWiccan: Automatically generated page update

2013-07-18T20:30:00Z

Automatically generated page update

← Older revision		Revision as of 20:30, 18 July 2013
Line 2:		Line 2:
	<span class="pageSubtitle">Execute Model 204 commands on sdaemon</span>		<span class="pageSubtitle">Execute Model 204 commands on sdaemon</span>

	<p class="~~warning~~">Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $CommBg function is [[Run (Daemon function)]]. The OO APIs emphasize the use of the [[List of Daemon methods\|Daemon methods]]; users are strongly urged to use the new Daemon API instead of the old $functions.</p>		<p class="warn"><b>Note: </b>Most Sirius $functions have been deprecated in favor of Object Oriented methods. The OO equivalent for the $CommBg function is [[Run (Daemon function)]]. The OO APIs emphasize the use of the [[List of Daemon methods\|Daemon methods]]; users are strongly urged to use the new Daemon API instead of the old $functions.</p>

	This function allows one or more <var class="product">Model 204</var> commands to be executed on an sdaemon. It has two basic modes of operation:		This function allows one or more <var class="product">Model 204</var> commands to be executed on an sdaemon. It has two basic modes of operation: