msiSetNumThreads ( msParam_t *  xsizePerThrInMbStr,
msParam_t *  xmaxNumThrStr,
msParam_t *  xwindowSizeStr,
ruleExecInfo_t *  rei 
)
Description:
This microservice specifies the parameters for determining the number of threads to use for data transfer. It sets the number of threads and the TCP window size.
Module:
core
Since:
pre-2.1
Author:
Mike Wan
Date:
2007
Note:
The msiSetNumThreads function must be present or no thread will be used for all transfer.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] xsizePerThrInMbStr - The number of threads is computed using: numThreads = fileSizeInMb / sizePerThrInMb + 1 where sizePerThrInMb is an integer value in MBytes. It also accepts the word "default" which sets sizePerThrInMb to a default value of 32.
[in] xmaxNumThrStr - The maximum number of threads to use. It accepts integer value up to 16. It also accepts the word "default" which sets maxNumThr to a default value of 4.
[in] xwindowSizeStr - The TCP window size in Bytes for the parallel transfer. A value of 0 or "default" means a default size of 1,048,576 Bytes.
[in,out] rei - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation.
Session Variables Used:
  • rei->doinp->numThreads, rei->doinp->dataSize
Session Variables Modified:
  • rei->rsComm->windowSize (rei->rsComm == NULL, OK),
iCAT Attributes Used:
none
iCAT Attributes Modified:
none
Side Effect:
none
Returns:
integer
Return values:
0 on success
Precondition:
none
Postcondition:
none
See also:
none

Definition at line 805 of file reSysDataObjOpr.c.

Generated on Thu Oct 31 10:19:17 2013 for iRODS Documentation by  doxygen 1.6.3