.\" -------------------------------------------------------------------------- .\" .\" //===// //===== //===// // // //===// .\" // // // // // // // // // .\" //===// //===== //===// // // //===<< .\" // \\ // // // // // // .\" // \\ =====// // //===== // //===// Version III .\" .\" ------------- An Efficient RSerPool Prototype Implementation ------------- .\" .\" Copyright (C) 2002-2023 by Thomas Dreibholz .\" .\" This program is free software: you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by .\" the Free Software Foundation, either version 3 of the License, or .\" (at your option) any later version. .\" .\" This program is distributed in the hope that it will be useful, .\" but WITHOUT ANY WARRANTY; without even the implied warranty of .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the .\" GNU General Public License for more details. .\" .\" You should have received a copy of the GNU General Public License .\" along with this program. If not, see . .\" .\" Contact: thomas.dreibholz@gmail.com .\" .\" ###### Setup ############################################################ .Dd June 06, 2012 .Dt ScriptingClient 1 .Os Scripting Client .\" ###### Name ############################################################# .Sh NAME .Nm scriptingclient .Nd RSerPool Client (PU) for the Scripting service .\" ###### Synopsis ######################################################### .Sh SYNOPSIS .Nm scriptingclient .Op Fl poolhandle=pool_handle .Op Fl environment=file_name .Op Fl input=file_name .Op Fl output=file_name .Op Fl quiet .Op Fl maxretry=trials .Op Fl retrydelay=milliseconds .Op Fl runid=description .Op Fl transmittimeout=milliseconds .Op Fl keepaliveinterval=milliseconds .Op Fl keepalivetimeout=milliseconds .Op Fl cspinterval=milliseconds .Op Fl cspserver=address:port .Op Fl logappend=filename .Op Fl logcolor=on|off .Op Fl logfile=filename .Op Fl loglevel=0-9 .\" ###### Description ###################################################### .Sh DESCRIPTION .Nm scriptingclient is a Reliable Server Pooling (RSerPool) pool user (PU) for the scripting service. The purpose of this service is to distribute input data to a scripting PE, execute a script doing some useful work on the input data and returning output data. For example, this service can be used for distributed simulation processing. .Pp .\" ###### Arguments ######################################################## .Sh ARGUMENTS The following options are available: .Bl -tag -width indent .It Fl poolhandle=pool_handle Sets the PH to a non-default value; otherwise, the default setting is "ScriptingPool". .\" ====== Service parameters =============================================== .It Service Parameters: .Bl -tag -width indent .It Fl environment=file_name Sets the name of the environment file to upload to the PE. The PE may cache this environment file, allowing to skip a subsequent upload of the same environment file. .It Fl input=file_name Sets the name of the input file to upload to the PE. .It Fl output=file_name Sets the name of the output file to write the download from the PE to. .It Fl quiet Turns on quiet mode, i.e. only few information is printed. .It Fl maxretry=trials Maximum number of retries upon errors on the remote site. The error counter only increments when the remote-side script returns a non-zero error code. When the error limit is reached, the received output file will be downloaded for debugging purposes. .It Fl retrydelay=milliseconds Sets the retry delay upon failover in milliseconds. .It Fl runid=description Add the given description to all log lines of the scripting service PU operation. This can be useful when multiple PUs are running simultaneously. .It Fl transmittimeout=milliseconds Sets the transmission timeout in milliseconds. .It Fl keepaliveinterval=milliseconds Sets the keep-alive interval in milliseconds. .It Fl keepalivetimeout=milliseconds Sets the keep-alive timeout in milliseconds. .El .\" ====== ASAP Protocol ==================================================== .It ASAP Protocol Parameters: .Bl -tag -width indent .It Fl registrar=address:port Adds a static PR entry into the Registrar Table. It is possible to add multiple entries. .It Fl registrarannouncetimeout=milliseconds Sets the timeout for ASAP announces via multicast. .It Fl registrarconnecttimeout=milliseconds Sets the timeout for ASAP connection establishment. .It Fl registrarconnectmaxtrials=trials Sets the maximum number of ASAP connection establishment trials. .It Fl registrarrequesttimeout=milliseconds Sets the timeout for ASAP requests. .It Fl registrarresponsetimeout=milliseconds Sets the timeout for waiting to receive ASAP responses. .It Fl registrarrequestmaxtrials=trials Sets the maximum number of ASAP request trials. .El .\" ====== Component Status Protocol ======================================== .It Component Status Protocol (CSP) Parameters: .Bl -tag -width indent .It Fl cspinterval=milliseconds Sets the interval for the CSP status updates in milliseconds. By default, the content of the environment variable CSP_INTERVAL is used. If not defined, no CSP status reports will be sent. .It Fl cspserver=address:port Sets the address of a CSP monitor server. By default, the content of the environment variable CSP_SERVER is used. If not defined, no CSP status reports will be sent. .El .\" ====== Logging ========================================================== .It Logging Parameters: .Bl -tag -width indent .It Fl logappend=filename Write logging output to a file (default is stdout); output will be appended to given file. .It Fl logcolor=on|off Turns ANSI colorization of the logging output on or off. .It Fl logfile=filename Write logging output to a file (default is stdout); given file will be overwritten. .It Fl loglevel=0-9 Sets the logging verbosity from 0 (none) to 9 (very verbose). It is recommended to use at least a value of 2 to see possibly important error messages and warnings. .El .El .Pp .\" ###### Environment ###################################################### .Sh ENVIRONMENT .Nm scriptingclient uses the environment variables CSP_SERVER and CSP_INTERVAL to define a CSP server to send reports to in the specified interval. .\" ###### Diagnostics ###################################################### .Sh DIAGNOSTICS If loglevel>0, log messages will be printed to stdout or into a specified log file. .\" ###### See also ######################################################### .Sh SEE ALSO For a detailed introduction to RSerPool, see: .br https://duepublico.uni-duisburg-essen.de/servlets/DerivateServlet/Derivate-16326/Dre2006_final.pdf .Pp Thomas Dreibholz's RSerPool Page: .br https://www.nntb.no/~dreibh/rserpool/