irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

dataObjRsync.h
Go to the documentation of this file.
1 
3 /* dataObjRsync.h - This dataObj may be generated by a program or script
4  */
5 
6 #ifndef DATA_OBJ_RSYNC_H__
7 #define DATA_OBJ_RSYNC_H__
8 
9 /* This is a Object File I/O API call */
10 
11 #include "rcConnect.h"
12 #include "dataObjInpOut.h"
13 #include "objInfo.h"
14 #include "msParam.h"
15 
16 /* prototype for the client call */
17 /* rcDataObjRsync - Synchronize the data between a local copy (local file
18  * system) and the copy stored in iRODS or between two iRODS copies.
19  * Input -
20  * rcComm_t *conn - The client connection handle.
21  * dataObjInp_t *dataObjInp - generic dataObj input. Relevant items are:
22  * objPath - the path of the data object.
23  * condInput - conditional Input
24  * ALL_KW - update all copies.
25  * FORCE_FLAG_KW - always needed.
26  * VERIFY_BY_SIZE_KW - use size instead of checksum value.
27  * DEST_RESC_NAME_KW - "value" = The destination Resource.
28  * RSYNC_MODE_KW - valid "value" are :
29  * IRODS_TO_IRODS - sync an iRODS object to an iRODS object.
30  * IRODS_TO_LOCAL - sync a local file to an iRODS object.
31  * LOCAL_TO_IRODS - sync an iRODS object to a local file.
32  * RSYNC_DEST_PATH_KW - "value" = the destination path.
33  * If RSYNC_MODE_KW == IRODS_TO_IRODS, it is an iRODS path.
34  * if RSYNC_MODE_KW == IRODS_TO_LOCAL, it is an iRODS object.
35  * if RSYNC_MODE_KW == LOCAL_TO_IRODS, it is a local file.
36  * RSYNC_CHKSUM_KW - "value" = checksum value.
37  * return value - The status of the operation.
38  */
39 #ifdef __cplusplus
40 extern "C"
41 #endif
42 int rcDataObjRsync( rcComm_t *conn, dataObjInp_t *dataObjInp );
43 int _rcDataObjRsync( rcComm_t *conn, dataObjInp_t *dataObjInp, msParamArray_t **outParamArray );
44 
45 #endif
rcComm_t
Definition: rcConnect.h:95
msParam.h
rcConnect.h
dataObjInpOut.h
_rcDataObjRsync
int _rcDataObjRsync(rcComm_t *conn, dataObjInp_t *dataObjInp, msParamArray_t **outParamArray)
Definition: rcDataObjRsync.cpp:221
DataObjInp
Definition: dataObjInpOut.h:65
objInfo.h
rcDataObjRsync
int rcDataObjRsync(rcComm_t *conn, dataObjInp_t *dataObjInp)
Definition: rcDataObjRsync.cpp:92
MsParamArray
Definition: msParam.h:84