msiCollRepl ( msParam_t *  collection,
msParam_t *  msKeyValStr,
msParam_t *  status,
ruleExecInfo_t *  rei 
)
Description:
This microservice wraps the rsCollRepl() routine to replicate a collection.
Module:
core
Since:
pre-2.1
Author:
Antoine de Torcy
Date:
2008-08-19
Note:
This call does not require client interaction, which means it can be used through rcExecMyRule (irule) or internally by the server.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] collection - A CollInp_MS_T or a STR_MS_T with the irods path of the collection to replicate.
[in] msKeyValStr - Optional - a STR_MS_T. This is the special msKeyValStr format of keyWd1=value1++++keyWd2=value2++++keyWd3=value3... If the keyWd is not specified (without the '=' char), the value is assumed to be the target resource ("destRescName") for backward compatibility. Valid keyWds are:

  • "destRescName" - the target resource to replicate to.
  • "backupRescName" - the target resource to backup the data. If this keyWd is used, the backup mode will be switched on.
  • "rescName" - the resource of the source copy.
  • "updateRepl" - update other replicas with the latest copy. This keyWd has no value. But the '=' character is still needed.
  • "replNum" - the replica number to use as source.
  • "numThreads" - the number of threads to use.
  • "all" - replicate to all resources in the resource group. This keyWd has no value.
  • "irodsAdmin" - admin user replicate other users' files. This keyWd has no value.
  • "verifyChksum" - verify the transfer using checksum. This keyWd has no value.
[out] status - a CollOprStat_t for detailed operation status.
[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:
none
Session Variables Modified:
none
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 3128 of file reDataObjOpr.c.

Generated on Fri Mar 15 13:58:02 2013 for iRODS Documentation by  doxygen 1.6.3