msiDataObjRepl ( msParam_t *  inpParam1,
msParam_t *  msKeyValStr,
msParam_t *  outParam,
ruleExecInfo_t *  rei 
)
Description:
This microservice replicates a file in a Collection (it assigns a different replica number to the new copy in the iCAT Metadata Catalog).
Module:
core
Since:
pre-2.1
Author:
Mike Wan
Date:
2007
Note:
Can be called by client through irule
The replica is physically stored in the ‘tgReplResc’ Resource. *Junk contains the status of the operation. In the Rule, the resource is provided as part of the call instead of as an input through a *parameter.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] inpParam1 - a msParam of type DataObjInp_MS_T or STR_MS_T which would be the obj Path.
[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.
  • "rbudpTransfer" - use RBUDP (datagram) protocol for the data transfer. This keyWd has no value.
  • "rbudpSendRate" - Valid only if "rbudpTransfer" is on. This is the send rate in kbits/sec. The default is 600,000.
  • "rbudpPackSize" - Valid only if "rbudpTransfer" is on. This is the packet size in bytes. The default is 8192.
[out] outParam - a msParam of type INT_MS_T which is a status of the operation.
[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 901 of file reDataObjOpr.c.

Generated on Tue May 14 16:56:43 2013 for iRODS Documentation by  doxygen 1.6.3