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)  

dataObjOpenAndStat.h
Go to the documentation of this file.
1 #ifndef DATA_OBJ_OPEN_AND_STAT_H__
2 #define DATA_OBJ_OPEN_AND_STAT_H__
3 
4 #include "rodsType.h"
5 #include "rcConnect.h"
6 #include "dataObjInpOut.h"
7 
8 typedef struct OpenStat {
12  int l3descInx;
15  int replNum;
17 #define OpenStat_PI "double dataSize; str dataType[NAME_LEN]; str dataMode[SHORT_STR_LEN]; int l3descInx; int replStatus; int rescTypeInx; int replNum;"
18 
19 /* prototype for the client call */
20 /* rcDataObjOpenAndStat - Open And Stat a iRODS data object. This is the same
21  * as the rcDataObjOpen call except it returns a openStat_t output.
22  * Input -
23  * rcComm_t *conn - The client connection handle.
24  * dataObjInp_t *dataObjInp - generic dataObj input. Relevant items are:
25  * objPath - the path of the data object.
26  * dataType - the data type of the object (optional).
27  * openFlag - O_WRONLY, O_RDONLY , etc. The O_CREAT will create the
28  * file if it does not exist.
29  * condInput - condition input (optional).
30  * DATA_TYPE_KW - "value" = the data type of the object
31  * FORCE_FLAG_KW - overwrite an existing data object
32  * REG_CHKSUM_KW - compute the checksum value
33  * VERIFY_CHKSUM_KW - compute and verify the checksum on the data.
34  * FILE_PATH_KW - "value" = the physical path of the
35  * destination file. Vaild only if O_CREAT is on.
36  * REPL_NUM_KW - "value" = The replica number of the copy to
37  * open.
38  * DEST_RESC_NAME_KW - "value" = The destination Resource. Vaild
39  * only if O_CREAT is on.
40  *
41  * OutPut -
42  * int l1descInx - an integer descriptor.
43  */
44 
45 #ifdef __cplusplus
46 extern "C"
47 #endif
48 int rcDataObjOpenAndStat( rcComm_t *conn, dataObjInp_t *dataObjInp, openStat_t **openStat );
49 
50 #endif
rcComm_t
Definition: rcConnect.h:95
rcDataObjOpenAndStat
int rcDataObjOpenAndStat(rcComm_t *conn, dataObjInp_t *dataObjInp, openStat_t **openStat)
Definition: rcDataObjOpenAndStat.cpp:69
rcConnect.h
OpenStat::replNum
int replNum
Definition: dataObjOpenAndStat.h:15
OpenStat::dataType
char dataType[64]
Definition: dataObjOpenAndStat.h:10
OpenStat::replStatus
int replStatus
Definition: dataObjOpenAndStat.h:13
dataObjInpOut.h
openStat_t
struct OpenStat openStat_t
OpenStat::rescTypeInx
int rescTypeInx
Definition: dataObjOpenAndStat.h:14
rodsType.h
DataObjInp
Definition: dataObjInpOut.h:65
OpenStat
Definition: dataObjOpenAndStat.h:8
OpenStat::l3descInx
int l3descInx
Definition: dataObjOpenAndStat.h:12
SHORT_STR_LEN
#define SHORT_STR_LEN
Definition: rodsDef.h:67
NAME_LEN
#define NAME_LEN
Definition: rodsDef.h:55
OpenStat::dataSize
rodsLong_t dataSize
Definition: dataObjOpenAndStat.h:9
OpenStat::dataMode
char dataMode[32]
Definition: dataObjOpenAndStat.h:11
rodsLong_t
long long rodsLong_t
Definition: rodsType.h:32