Python API: sam v8_1_5 sam.establishConsumer()
|  |
This is the python interface to the command 'sam establish consumer'.
Command Description:
Establish a consumer for this project, by calling the
sam_idl/sam_station/GPM2Consumer.establishNewConsumer interface
of the project master. (Hence, the project must already be running).
A 'consumer' is a 'container' for one or more consumer processes
(which must be separately established with the 'sam establish process'
command). The application name and version must be registered in the
SAM db (for bookkeeping purposes).
Uses sam_common_pylib/SamUtility/SamUserIdentifier.getSamUserIdentifier()
to determine your SAM identity.
If no group name is specified, the processing resources
will be assigned to the group under which the project is running
(obtained by querying the dbServer).
The application name, version (and family, if specified) must be registered
applications known to the SAM database. NOTE that the appFamily field will
be IGNORED if talking to a station version prior to v6_1_1_13.
Python Usage:
from Sam import sam
result = sam.establishConsumer(...)
Return value: consumerId (int)
Arguments are passed as keyword-value pairs, as in:
myfunc(arg1='myarg', arg2='anotherarg', d=1)
Argument Keyword Description:
(*) indicates that this keyword is required
>>> indicates that either the API object or the CLI equivalent (<<<) is required
====================================================================================================================================
KEYWORD DATA TYPE DESCRIPTION
------------------------------------------------------------------------------------------------------------------------------------
appFamily string application family of the application that the consumer will be using (default: unknown)
(*) appName string application name that the consumer will be using
(*) appVersion string application version that the consumer will be using
c SamBoolean automatically close all servants after each method call
corbaCallTimeout int time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
d SamBoolean debug mode
group string work group under which this consumer will be running
minimalOutput SamBoolean Write unadorned output (useful for scripting)
(*) project string name of the project against which the consumer should run
retryInterval int retry interval base in seconds; will multiply this base times retryCount (default: 5)
retryJitter int retry jitter, random jitter added to base retry interval times retryCount (default: 5)
retryMaxCount int number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
rtfile string routing file into which results will be written
s SamBoolean retrySilently mode (do not issue messages to stderr on proxy retries)
(*) station string name of the station where this project is running
t SamBoolean time-it mode (print additional info on timings)
v SamBoolean verbose mode
====================================================================================================================================
Environment Defaults:
c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
project = os.environ['SAM_PROJECT']
retryInterval = os.environ['SAM_PYAPI_RETRY_INTERVAL']
retryJitter = os.environ['SAM_PYAPI_RETRY_JITTER']
retryMaxCount = os.environ['SAM_PYAPI_RETRY_MAX_COUNT']
s = os.environ['SAM_PYAPI_RETRY_SILENTLY']
station = os.environ['SAM_STATION']
See Also: