msiDataObjRsync ( msParam_t *  inpParam1,
msParam_t *  inpParam2,
msParam_t *  inpParam3,
msParam_t *  inpParam4,
msParam_t *  outParam,
ruleExecInfo_t *  rei 
)
Description:
This microservice requests the client to call a rcDataObjRsync API as part of a workflow execution.
Module:
core
Since:
pre-2.1
Author:
Michael Wan
Date:
2007-02-12
Note:
For now, this microservice should only be used for IRODS_TO_IRODS mode because of the logistic difficulty with the microservice getting the checksum values of the local file.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] inpParam1 - A DataObjInp_MS_T or STR_MS_T which would be taken as dataObj path.
[in] inpParam2 - Optional - a STR_MS_T which specifies the rsync mode (RSYNC_MODE_KW). Valid mode is IRODS_TO_IRODS and IRODS_TO_COLLECTION.
[in] inpParam3 - Optional - a STR_MS_T which specifies the resource value (DEST_RESC_NAME_KW).
[in] inpParam4 - Optional - a STR_MS_T which specifies the (RSYNC_DEST_PATH_KW). For IRODS_TO_IRODS, this is the target path. For IRODS_TO_COLLECTION, this is the top level target collection. e.g., if dataObj (inpParam1) is /tempZone/home/rods/foo and the target collection (inpParam4) is /tempZone/archive, then the target path is /tempZone/archive/home/rods/foo.
[out] outParam - a INT_MS_T containing the 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 2631 of file reDataObjOpr.c.

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