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)  

rcGlobal.cpp
Go to the documentation of this file.
1 
3 /* global definition for client API */
4 
5 #ifndef RC_GLOBAL_H__
6 #define RC_GLOBAL_H__
7 
8 #include "rods.h"
9 #include "msParam.h"
10 #include "rodsPackTable.h" /* globally declare RodsPackTable */
11 #include "objInfo.h"
12 #include "rodsGenQuery.h"
13 #include "rodsGeneralUpdate.h"
14 #include "guiProgressCallback.h"
15 
17 
18 char *dataObjCond[] = {
19  ALL_KW, /* operation done on all replica */
20  COPIES_KW, /* the number of copies */
21  EXEC_LOCALLY_KW, /* execute locally */
22  FORCE_FLAG_KW, /* force update */
23  CLI_IN_SVR_FIREWALL_KW, /* client behind same firewall */
24  REG_CHKSUM_KW, /* register checksum */
25  VERIFY_CHKSUM_KW, /* verify checksum */
26  OBJ_PATH_KW, /* logical path of the object */
27  RESC_NAME_KW, /* resource name */
28  DEST_RESC_NAME_KW, /* destination resource name */
29  BACKUP_RESC_NAME_KW, /* destination resource name */
30  DATA_TYPE_KW, /* data type */
32  CHKSUM_KW,
33  VERSION_KW,
34  FILE_PATH_KW, /* the physical file path */
35  REPL_NUM_KW, /* replica number */
36  REPL_STATUS_KW, /* status of the replica */
37  DATA_INCLUDED_KW, /* data included in the input bytes buffer */
48  DATA_ID_KW,
49  COLL_ID_KW,
52  "ENDOFLIST"
53 };
54 
55 char *compareOperator[] = {
56  ">", "<", "=",
57  "like", "between", "LIKE", "BETWEEN",
58  "NOT LIKE", "NOT BETWEEN", "NOT LIKE", "NOT BETWEEN",
59  "ENDOFLIST"
60 };
61 
62 char *rescCond[] = {
77  RESC_ID_KW,
81  "ENDOFLIST"
82 };
83 
84 char *userCond[] = {
105  "ENDOFLIST"
106 };
107 
108 char *collCond[] = {
109  COLL_NAME_KW,
121  COLL_ID_KW,
122  "ENDOFLIST"
123 };
124 
125 /* Note; all structFile name must contain the word structFile */
126 
131 };
132 
134 
135 /* valid keyWds for dataObjInp_t */
142  {ALL_FLAG, ALL_KW},
145  {ADMIN_FLAG, ADMIN_KW},
160  {UNREG_FLAG, UNREG_KW},
164 };
165 
166 int NumDataObjInpKeyWd = sizeof( DataObjInpKeyWd ) / sizeof( validKeyWd_t );
167 
168 /* valid keyWds for collInp_t */
175  {ALL_FLAG, ALL_KW},
177  {ADMIN_FLAG, ADMIN_KW},
185 };
186 
187 int NumCollInpKeyWd = sizeof( CollInpKeyWd ) / sizeof( validKeyWd_t );
188 
189 /* valid keyWds for structFileExtAndRegInp */
198 };
199 
201 
202 struct timeval SysTimingVal;
203 
204 #ifdef __cplusplus
205 extern "C" {
206 #endif
208 
209 #ifdef __cplusplus
210 }
211 #endif
212 #endif // RC_GLOBAL_H__
RBUDP_SEND_RATE_KW
#define RBUDP_SEND_RATE_KW
Definition: rodsKeyWdDef.h:78
USER_CREATE_PROXY_KW
#define USER_CREATE_PROXY_KW
Definition: rodsKeyWdDef.h:183
RESC_NAME_KW
#define RESC_NAME_KW
Definition: rodsKeyWdDef.h:19
NUM_THREADS_FLAG
#define NUM_THREADS_FLAG
Definition: msParam.h:125
UNREG_KW
#define UNREG_KW
Definition: rodsKeyWdDef.h:64
ADMIN_FLAG
#define ADMIN_FLAG
Definition: msParam.h:114
COLL_PARENT_NAME_KW
#define COLL_PARENT_NAME_KW
Definition: rodsKeyWdDef.h:191
NULL
#define NULL
Definition: rodsDef.h:70
RESC_STATUS_KW
#define RESC_STATUS_KW
Definition: rodsKeyWdDef.h:147
USER_AUTH_SCHEME_CLIENT_KW
#define USER_AUTH_SCHEME_CLIENT_KW
Definition: rodsKeyWdDef.h:170
USER_INFO_CLIENT_KW
#define USER_INFO_CLIENT_KW
Definition: rodsKeyWdDef.h:171
UPDATE_REPL_FLAG
#define UPDATE_REPL_FLAG
Definition: msParam.h:115
OPEN_FLAGS_FLAG
#define OPEN_FLAGS_FLAG
Definition: msParam.h:122
COLL_OWNER_NAME_KW
#define COLL_OWNER_NAME_KW
Definition: rodsKeyWdDef.h:192
DATA_MODIFY_KW
#define DATA_MODIFY_KW
Definition: rodsKeyWdDef.h:42
GATEWAY_ADDR_KW
#define GATEWAY_ADDR_KW
Definition: rodsKeyWdDef.h:148
DATA_EXPIRY_KW
#define DATA_EXPIRY_KW
Definition: rodsKeyWdDef.h:39
USER_INFO_PROXY_KW
#define USER_INFO_PROXY_KW
Definition: rodsKeyWdDef.h:181
collCond
char * collCond[]
Definition: rcGlobal.cpp:108
REPL_NUM_FLAG
#define REPL_NUM_FLAG
Definition: msParam.h:116
msParam.h
VERSION_KW
#define VERSION_KW
Definition: rodsKeyWdDef.h:27
HAAW_STRUCT_FILE_STR
#define HAAW_STRUCT_FILE_STR
Definition: objInfo.h:66
DEST_RESC_NAME_FLAG
#define DEST_RESC_NAME_FLAG
Definition: msParam.h:108
USER_COMMENT_PROXY_KW
#define USER_COMMENT_PROXY_KW
Definition: rodsKeyWdDef.h:182
USER_MODIFY_CLIENT_KW
#define USER_MODIFY_CLIENT_KW
Definition: rodsKeyWdDef.h:174
NumStructFileType
int NumStructFileType
Definition: rcGlobal.cpp:133
DataObjInpKeyWd
validKeyWd_t DataObjInpKeyWd[]
Definition: rcGlobal.cpp:136
DATA_ACCESS_INX_KW
#define DATA_ACCESS_INX_KW
Definition: rodsKeyWdDef.h:44
RBUDP_TRANSFER_KW
#define RBUDP_TRANSFER_KW
Definition: rodsKeyWdDef.h:76
COLL_CREATE_KW
#define COLL_CREATE_KW
Definition: rodsKeyWdDef.h:198
USER_NAME_CLIENT_KW
#define USER_NAME_CLIENT_KW
Definition: rodsKeyWdDef.h:164
rodsGeneralUpdate.h
FORCE_FLAG_FLAG
#define FORCE_FLAG_FLAG
Definition: msParam.h:110
rodsPackTable.h
CHKSUM_KW
#define CHKSUM_KW
Definition: rodsKeyWdDef.h:25
AUTH_STR_CLIENT_KW
#define AUTH_STR_CLIENT_KW
Definition: rodsKeyWdDef.h:169
RBUDP_TRANSFER_FLAG
#define RBUDP_TRANSFER_FLAG
Definition: msParam.h:132
COLL_ACCESS_KW
#define COLL_ACCESS_KW
Definition: rodsKeyWdDef.h:200
FREE_SPACE_KW
#define FREE_SPACE_KW
Definition: rodsKeyWdDef.h:150
COLL_NAME_FLAG
#define COLL_NAME_FLAG
Definition: msParam.h:128
RESC_TYPE_INX_KW
#define RESC_TYPE_INX_KW
Definition: rodsKeyWdDef.h:155
guiProgressCallback.h
HAAW_STRUCT_FILE_T
@ HAAW_STRUCT_FILE_T
Definition: objInfo.h:54
USER_TYPE_PROXY_KW
#define USER_TYPE_PROXY_KW
Definition: rodsKeyWdDef.h:178
TAR_STRUCT_FILE_STR
#define TAR_STRUCT_FILE_STR
Definition: objInfo.h:67
REPL_NUM_KW
#define REPL_NUM_KW
Definition: rodsKeyWdDef.h:30
STREAMING_KW
#define STREAMING_KW
Definition: rodsKeyWdDef.h:47
ALL_KW
#define ALL_KW
Definition: rodsKeyWdDef.h:10
RODS_ZONE_PROXY_KW
#define RODS_ZONE_PROXY_KW
Definition: rodsKeyWdDef.h:176
USER_TYPE_CLIENT_KW
#define USER_TYPE_CLIENT_KW
Definition: rodsKeyWdDef.h:168
USER_MODIFY_PROXY_KW
#define USER_MODIFY_PROXY_KW
Definition: rodsKeyWdDef.h:184
NUM_THREADS_KW
#define NUM_THREADS_KW
Definition: rodsKeyWdDef.h:93
ADMIN_RMTRASH_FLAG
#define ADMIN_RMTRASH_FLAG
Definition: msParam.h:130
COLL_OWNER_ZONE_KW
#define COLL_OWNER_ZONE_KW
Definition: rodsKeyWdDef.h:193
COLL_EXPIRY_KW
#define COLL_EXPIRY_KW
Definition: rodsKeyWdDef.h:197
CREATE_MODE_KW
#define CREATE_MODE_KW
Definition: rodsKeyWdDef.h:89
DATA_SIZE_KW
#define DATA_SIZE_KW
Definition: rodsKeyWdDef.h:24
BACKUP_RESC_NAME_FLAG
#define BACKUP_RESC_NAME_FLAG
Definition: msParam.h:109
USER_AUTH_SCHEME_PROXY_KW
#define USER_AUTH_SCHEME_PROXY_KW
Definition: rodsKeyWdDef.h:180
DATA_TYPE_KW
#define DATA_TYPE_KW
Definition: rodsKeyWdDef.h:23
REPL_STATUS_KW
#define REPL_STATUS_KW
Definition: rodsKeyWdDef.h:32
RESC_TYPE_KW
#define RESC_TYPE_KW
Definition: rodsKeyWdDef.h:144
RESC_LOC_KW
#define RESC_LOC_KW
Definition: rodsKeyWdDef.h:143
CHKSUM_ALL_FLAG
#define CHKSUM_ALL_FLAG
Definition: msParam.h:118
REG_CHKSUM_KW
#define REG_CHKSUM_KW
Definition: rodsKeyWdDef.h:15
BACKUP_RESC_NAME_KW
#define BACKUP_RESC_NAME_KW
Definition: rodsKeyWdDef.h:22
DEST_RESC_NAME_KW
#define DEST_RESC_NAME_KW
Definition: rodsKeyWdDef.h:20
DATA_COMMENTS_KW
#define DATA_COMMENTS_KW
Definition: rodsKeyWdDef.h:40
EXEC_LOCALLY_KW
#define EXEC_LOCALLY_KW
Definition: rodsKeyWdDef.h:12
COPIES_KW
#define COPIES_KW
Definition: rodsKeyWdDef.h:11
USER_COMMENT_CLIENT_KW
#define USER_COMMENT_CLIENT_KW
Definition: rodsKeyWdDef.h:172
HOST_CLIENT_KW
#define HOST_CLIENT_KW
Definition: rodsKeyWdDef.h:166
DATA_ID_KW
#define DATA_ID_KW
Definition: rodsKeyWdDef.h:48
DATA_INCLUDED_KW
#define DATA_INCLUDED_KW
Definition: rodsKeyWdDef.h:36
RODS_ZONE_CLIENT_KW
#define RODS_ZONE_CLIENT_KW
Definition: rodsKeyWdDef.h:165
ValidKeyWd
Definition: msParam.h:100
RESC_MAX_OBJ_SIZE_KW
#define RESC_MAX_OBJ_SIZE_KW
Definition: rodsKeyWdDef.h:149
RESC_CREATE_KW
#define RESC_CREATE_KW
Definition: rodsKeyWdDef.h:159
COLL_MODIFY_KW
#define COLL_MODIFY_KW
Definition: rodsKeyWdDef.h:199
DATA_TYPE_FLAG
#define DATA_TYPE_FLAG
Definition: msParam.h:117
RESC_CLASS_INX_KW
#define RESC_CLASS_INX_KW
Definition: rodsKeyWdDef.h:156
FILE_PATH_FLAG
#define FILE_PATH_FLAG
Definition: msParam.h:120
HOST_PROXY_KW
#define HOST_PROXY_KW
Definition: rodsKeyWdDef.h:177
compareOperator
char * compareOperator[]
Definition: rcGlobal.cpp:55
CHKSUM_ALL_KW
#define CHKSUM_ALL_KW
Definition: rodsKeyWdDef.h:59
COLL_MAP_ID_KW
#define COLL_MAP_ID_KW
Definition: rodsKeyWdDef.h:194
UNREG_FLAG
#define UNREG_FLAG
Definition: msParam.h:136
NO_OPEN_FLAG_KW
#define NO_OPEN_FLAG_KW
Definition: rodsKeyWdDef.h:45
gGuiProgressCB
guiProgressCallback gGuiProgressCB
Definition: rcGlobal.cpp:207
RBUDP_PACK_SIZE_KW
#define RBUDP_PACK_SIZE_KW
Definition: rodsKeyWdDef.h:79
RMTRASH_KW
#define RMTRASH_KW
Definition: rodsKeyWdDef.h:65
SysTimingVal
struct timeval SysTimingVal
Definition: rcGlobal.cpp:202
ADMIN_KW
#define ADMIN_KW
Definition: rodsKeyWdDef.h:62
OPR_TYPE_KW
#define OPR_TYPE_KW
Definition: rodsKeyWdDef.h:94
NumDataObjInpKeyWd
int NumDataObjInpKeyWd
Definition: rcGlobal.cpp:166
UPDATE_REPL_KW
#define UPDATE_REPL_KW
Definition: rodsKeyWdDef.h:75
LOCAL_PATH_FLAG
#define LOCAL_PATH_FLAG
Definition: msParam.h:112
CLIENT_PT
#define CLIENT_PT
Definition: rodsDef.h:77
OPR_TYPE_FLAG
#define OPR_TYPE_FLAG
Definition: msParam.h:126
StructFileTypeDef
Definition: objInfo.h:325
LOCAL_PATH_KW
#define LOCAL_PATH_KW
Definition: rodsKeyWdDef.h:55
STATUS_STRING_KW
#define STATUS_STRING_KW
Definition: rodsKeyWdDef.h:52
COLL_ID_KW
#define COLL_ID_KW
Definition: rodsKeyWdDef.h:202
DEF_RESC_NAME_KW
#define DEF_RESC_NAME_KW
Definition: rodsKeyWdDef.h:21
rescCond
char * rescCond[]
Definition: rcGlobal.cpp:62
RESC_NAME_FLAG
#define RESC_NAME_FLAG
Definition: msParam.h:107
MSSO_STRUCT_FILE_STR
#define MSSO_STRUCT_FILE_STR
Definition: objInfo.h:71
COLL_NAME_KW
#define COLL_NAME_KW
Definition: rodsKeyWdDef.h:190
RBUDP_SEND_RATE_FLAG
#define RBUDP_SEND_RATE_FLAG
Definition: msParam.h:133
COLL_FLAGS_KW
#define COLL_FLAGS_KW
Definition: rodsKeyWdDef.h:96
DATA_ACCESS_KW
#define DATA_ACCESS_KW
Definition: rodsKeyWdDef.h:43
dataObjCond
char * dataObjCond[]
Definition: rcGlobal.cpp:18
OPEN_FLAGS_KW
#define OPEN_FLAGS_KW
Definition: rodsKeyWdDef.h:90
RMTRASH_FLAG
#define RMTRASH_FLAG
Definition: msParam.h:129
OBJ_PATH_FLAG
#define OBJ_PATH_FLAG
Definition: msParam.h:127
USER_NAME_PROXY_KW
#define USER_NAME_PROXY_KW
Definition: rodsKeyWdDef.h:175
RBUDP_PACK_SIZE_FLAG
#define RBUDP_PACK_SIZE_FLAG
Definition: msParam.h:134
DATA_CREATE_KW
#define DATA_CREATE_KW
Definition: rodsKeyWdDef.h:41
NumCollInpKeyWd
int NumCollInpKeyWd
Definition: rcGlobal.cpp:187
rodsGenQuery.h
VERIFY_CHKSUM_FLAG
#define VERIFY_CHKSUM_FLAG
Definition: msParam.h:113
FORCE_FLAG_KW
#define FORCE_FLAG_KW
Definition: rodsKeyWdDef.h:13
CollInpKeyWd
validKeyWd_t CollInpKeyWd[]
Definition: rcGlobal.cpp:169
objInfo.h
AUTH_STR_PROXY_KW
#define AUTH_STR_PROXY_KW
Definition: rodsKeyWdDef.h:179
TAR_STRUCT_FILE_T
@ TAR_STRUCT_FILE_T
Definition: objInfo.h:55
RESC_COMMENTS_KW
#define RESC_COMMENTS_KW
Definition: rodsKeyWdDef.h:158
FORCE_CHKSUM_KW
#define FORCE_CHKSUM_KW
Definition: rodsKeyWdDef.h:60
CLI_IN_SVR_FIREWALL_KW
#define CLI_IN_SVR_FIREWALL_KW
Definition: rodsKeyWdDef.h:14
VERIFY_CHKSUM_KW
#define VERIFY_CHKSUM_KW
Definition: rodsKeyWdDef.h:16
DATA_SIZE_FLAGS
#define DATA_SIZE_FLAGS
Definition: msParam.h:124
DATA_OWNER_KW
#define DATA_OWNER_KW
Definition: rodsKeyWdDef.h:37
OBJ_PATH_KW
#define OBJ_PATH_KW
Definition: rodsKeyWdDef.h:18
FREE_SPACE_TIME_KW
#define FREE_SPACE_TIME_KW
Definition: rodsKeyWdDef.h:151
ProcessType
int ProcessType
Definition: rcGlobal.cpp:16
COLL_COMMENTS_KW
#define COLL_COMMENTS_KW
Definition: rodsKeyWdDef.h:196
DATA_OWNER_ZONE_KW
#define DATA_OWNER_ZONE_KW
Definition: rodsKeyWdDef.h:38
StructFileExtAndRegInpKeyWd
validKeyWd_t StructFileExtAndRegInpKeyWd[]
Definition: rcGlobal.cpp:190
USER_CREATE_CLIENT_KW
#define USER_CREATE_CLIENT_KW
Definition: rodsKeyWdDef.h:173
RESC_ID_KW
#define RESC_ID_KW
Definition: rodsKeyWdDef.h:157
NumStructFileExtAndRegInpKeyWd
int NumStructFileExtAndRegInpKeyWd
Definition: rcGlobal.cpp:200
COLL_FLAGS_FLAG
#define COLL_FLAGS_FLAG
Definition: msParam.h:123
ALL_FLAG
#define ALL_FLAG
Definition: msParam.h:111
COLL_INHERITANCE_KW
#define COLL_INHERITANCE_KW
Definition: rodsKeyWdDef.h:195
FREE_SPACE_TIMESTAMP_KW
#define FREE_SPACE_TIMESTAMP_KW
Definition: rodsKeyWdDef.h:152
FILE_PATH_KW
#define FILE_PATH_KW
Definition: rodsKeyWdDef.h:28
CREATE_MODE_FLAG
#define CREATE_MODE_FLAG
Definition: msParam.h:121
guiProgressCallback
void(* guiProgressCallback)(operProgress_t *operProgress)
Definition: guiProgressCallback.h:19
MSSO_STRUCT_FILE_T
@ MSSO_STRUCT_FILE_T
Definition: objInfo.h:56
DATA_MAP_ID_KW
#define DATA_MAP_ID_KW
Definition: rodsKeyWdDef.h:53
StructFileTypeDef
structFileTypeDef_t StructFileTypeDef[]
Definition: rcGlobal.cpp:127
RESC_MODIFY_KW
#define RESC_MODIFY_KW
Definition: rodsKeyWdDef.h:160
DEF_RESC_NAME_FLAG
#define DEF_RESC_NAME_FLAG
Definition: msParam.h:131
RESC_VAULT_PATH_KW
#define RESC_VAULT_PATH_KW
Definition: rodsKeyWdDef.h:146
rods.h
COLL_ACCESS_INX_KW
#define COLL_ACCESS_INX_KW
Definition: rodsKeyWdDef.h:201
FORCE_CHKSUM_FLAG
#define FORCE_CHKSUM_FLAG
Definition: msParam.h:119
ADMIN_RMTRASH_KW
#define ADMIN_RMTRASH_KW
Definition: rodsKeyWdDef.h:63
RESC_ZONE_KW
#define RESC_ZONE_KW
Definition: rodsKeyWdDef.h:142
userCond
char * userCond[]
Definition: rcGlobal.cpp:84
RESC_CLASS_KW
#define RESC_CLASS_KW
Definition: rodsKeyWdDef.h:145