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)  

objInfo.h File Reference
#include "rodsType.h"
#include "rodsUser.h"
Include dependency graph for objInfo.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  SpecColl
 
struct  SpecCollCache
 
struct  KeyValPair
 
struct  DataObjInfo
 
struct  CollInfo
 
struct  RuleInfo
 
struct  InxIvalPair
 
struct  InxValPair
 
struct  StrArray
 
struct  IntArray
 
struct  transStat_t
 
struct  transferStat_t
 
struct  collOprStat_t
 
struct  TagStruct
 
struct  Subfile
 
struct  StructFileTypeDef
 

Macros

#define ALL_COPIES   -1 /* "all" */
 
#define GENERIC_DT_STR   "generic"
 
#define TAR_DT_STR   "tar file"
 
#define GZIP_TAR_DT_STR   "gzipTar"
 
#define BZIP2_TAR_DT_STR   "bzip2Tar"
 
#define ZIP_DT_STR   "zipFile"
 
#define MSSO_DT_STR   "msso file"
 
#define TAR_BUNDLE_DT_STR   "tar bundle"
 
#define GZIP_TAR_BUNDLE_DT_STR   "gzipTar bundle"
 
#define BZIP2_TAR_BUNDLE_DT_STR   "bzip2Tar bundle"
 
#define ZIP_BUNDLE_DT_STR   "zipFile bundle"
 
#define HAAW_DT_STR   "haaw file"
 
#define MAX_LINK_CNT   20 /* max number soft link in a path */
 
#define HAAW_STRUCT_FILE_STR   "haawStructFile"
 
#define TAR_STRUCT_FILE_STR   "tarStructFile"
 
#define MOUNT_POINT_STR   "mountPoint"
 
#define LINK_POINT_STR   "linkPoint"
 
#define INHERIT_PAR_SPEC_COLL_STR   "inheritParentSpecColl"
 
#define MSSO_STRUCT_FILE_STR   "mssoStructFile"
 
#define MSO_STR   "mso"
 
#define UNMOUNT_STR   "unmount"
 
#define OLD_COPY   0x0
 
#define NEWLY_CREATED_COPY   0x1
 
#define OPEN_EXISTING_COPY   0x10
 
#define FILE_PATH_HAS_CHG   0x20
 
#define NO_COMMIT_FLAG   0x1 /* used in chlModDataObjMeta and chlRegDataObj */
 
#define DEFAULT_FILE_MODE   0600
 
#define DEFAULT_DIR_MODE   0750
 
#define DISALLOW_PATH_REG   0 /* disallow path registration */
 
#define NO_CHK_PATH_PERM   1
 
#define DO_CHK_PATH_PERM   2
 
#define CHK_NON_VAULT_PATH_PERM   3 /* allow reg of user's vault path */
 
#define DISALLOW_PATH_REG_STR   "disallowPathReg"
 
#define NO_CHK_PATH_PERM_STR   "noChkPathPerm"
 
#define DO_CHK_PATH_PERM_STR   "doChkPathPerm"
 
#define CHK_NON_VAULT_PATH_PERM_STR   "chkNonVaultPathPerm"
 
#define NO_STAGING   0
 
#define STAGE_SRC   1
 
#define SYNC_DEST   2
 
#define DO_TRASH_CAN   0
 
#define NO_TRASH_CAN   1
 
#define CACHE_CL   0
 
#define ARCHIVAL_CL   1
 
#define BUNDLE_CL   2
 
#define COMPOUND_CL   3
 
#define DATABASE_CL   4
 
#define PRIMARY_FLAG   0x8000 /* primary class when this bit is set */
 
#define FILE_CNT_PER_STAT_OUT
 

Typedefs

typedef struct SpecColl specColl_t
 
typedef struct SpecCollCache specCollCache_t
 
typedef struct KeyValPair keyValPair_t
 
typedef struct DataObjInfo dataObjInfo_t
 
typedef struct CollInfo collInfo_t
 
typedef struct RuleInfo ruleInfo_t
 
typedef struct InxIvalPair inxIvalPair_t
 
typedef struct InxValPair inxValPair_t
 
typedef struct StrArray strArray_t
 
typedef struct IntArray intArray_t
 
typedef struct TagStruct tagStruct_t
 
typedef struct Subfile subFile_t
 
typedef struct StructFileTypeDef structFileTypeDef_t
 

Enumerations

enum  specCollClass_t { NO_SPEC_COLL, STRUCT_FILE_COLL, MOUNTED_COLL, LINKED_COLL }
 
enum  structFileType_t { NONE_STRUCT_FILE_T = 0, HAAW_STRUCT_FILE_T = 1, TAR_STRUCT_FILE_T = 2, MSSO_STRUCT_FILE_T = 3 }
 
enum  structFileOprType_t { NOT_SPEC_COLL_OPR, NON_STRUCT_FILE_SPEC_COLL_OPR, STRUCT_FILE_SPEC_COLL_OPR, NORMAL_OPR_ON_STRUCT_FILE_COLL }
 
enum  specCollPerm_t { UNKNOWN_COLL_PERM, READ_COLL_PERM, WRITE_COLL_PERM }
 
enum  rescCat_t { FILE_CAT, DB_CAT }
 
enum  createPath_t { NO_CREATE_PATH, CREATE_PATH }
 

Macro Definition Documentation

◆ ALL_COPIES

#define ALL_COPIES   -1 /* "all" */

Definition at line 25 of file objInfo.h.

◆ ARCHIVAL_CL

#define ARCHIVAL_CL   1

Definition at line 274 of file objInfo.h.

◆ BUNDLE_CL

#define BUNDLE_CL   2

Definition at line 275 of file objInfo.h.

◆ BZIP2_TAR_BUNDLE_DT_STR

#define BZIP2_TAR_BUNDLE_DT_STR   "bzip2Tar bundle"

Definition at line 37 of file objInfo.h.

◆ BZIP2_TAR_DT_STR

#define BZIP2_TAR_DT_STR   "bzip2Tar"

Definition at line 31 of file objInfo.h.

◆ CACHE_CL

#define CACHE_CL   0

Definition at line 273 of file objInfo.h.

◆ CHK_NON_VAULT_PATH_PERM

#define CHK_NON_VAULT_PATH_PERM   3 /* allow reg of user's vault path */

Definition at line 249 of file objInfo.h.

◆ CHK_NON_VAULT_PATH_PERM_STR

#define CHK_NON_VAULT_PATH_PERM_STR   "chkNonVaultPathPerm"

Definition at line 254 of file objInfo.h.

◆ COMPOUND_CL

#define COMPOUND_CL   3

Definition at line 276 of file objInfo.h.

◆ DATABASE_CL

#define DATABASE_CL   4

Definition at line 277 of file objInfo.h.

◆ DEFAULT_DIR_MODE

#define DEFAULT_DIR_MODE   0750

Definition at line 242 of file objInfo.h.

◆ DEFAULT_FILE_MODE

#define DEFAULT_FILE_MODE   0600

Definition at line 241 of file objInfo.h.

◆ DISALLOW_PATH_REG

#define DISALLOW_PATH_REG   0 /* disallow path registration */

Definition at line 246 of file objInfo.h.

◆ DISALLOW_PATH_REG_STR

#define DISALLOW_PATH_REG_STR   "disallowPathReg"

Definition at line 251 of file objInfo.h.

◆ DO_CHK_PATH_PERM

#define DO_CHK_PATH_PERM   2

Definition at line 248 of file objInfo.h.

◆ DO_CHK_PATH_PERM_STR

#define DO_CHK_PATH_PERM_STR   "doChkPathPerm"

Definition at line 253 of file objInfo.h.

◆ DO_TRASH_CAN

#define DO_TRASH_CAN   0

Definition at line 263 of file objInfo.h.

◆ FILE_CNT_PER_STAT_OUT

#define FILE_CNT_PER_STAT_OUT
Value:
10 /* the default file count per
* collOprStat output */

Definition at line 298 of file objInfo.h.

◆ FILE_PATH_HAS_CHG

#define FILE_PATH_HAS_CHG   0x20

Definition at line 118 of file objInfo.h.

◆ GENERIC_DT_STR

#define GENERIC_DT_STR   "generic"

Definition at line 28 of file objInfo.h.

◆ GZIP_TAR_BUNDLE_DT_STR

#define GZIP_TAR_BUNDLE_DT_STR   "gzipTar bundle"

Definition at line 36 of file objInfo.h.

◆ GZIP_TAR_DT_STR

#define GZIP_TAR_DT_STR   "gzipTar"

Definition at line 30 of file objInfo.h.

◆ HAAW_DT_STR

#define HAAW_DT_STR   "haaw file"

Definition at line 40 of file objInfo.h.

◆ HAAW_STRUCT_FILE_STR

#define HAAW_STRUCT_FILE_STR   "haawStructFile"

Definition at line 67 of file objInfo.h.

◆ INHERIT_PAR_SPEC_COLL_STR

#define INHERIT_PAR_SPEC_COLL_STR   "inheritParentSpecColl"

Definition at line 71 of file objInfo.h.

◆ LINK_POINT_STR

#define LINK_POINT_STR   "linkPoint"

Definition at line 70 of file objInfo.h.

◆ MAX_LINK_CNT

#define MAX_LINK_CNT   20 /* max number soft link in a path */

Definition at line 41 of file objInfo.h.

◆ MOUNT_POINT_STR

#define MOUNT_POINT_STR   "mountPoint"

Definition at line 69 of file objInfo.h.

◆ MSO_STR

#define MSO_STR   "mso"

Definition at line 73 of file objInfo.h.

◆ MSSO_DT_STR

#define MSSO_DT_STR   "msso file"

Definition at line 33 of file objInfo.h.

◆ MSSO_STRUCT_FILE_STR

#define MSSO_STRUCT_FILE_STR   "mssoStructFile"

Definition at line 72 of file objInfo.h.

◆ NEWLY_CREATED_COPY

#define NEWLY_CREATED_COPY   0x1

Definition at line 116 of file objInfo.h.

◆ NO_CHK_PATH_PERM

#define NO_CHK_PATH_PERM   1

Definition at line 247 of file objInfo.h.

◆ NO_CHK_PATH_PERM_STR

#define NO_CHK_PATH_PERM_STR   "noChkPathPerm"

Definition at line 252 of file objInfo.h.

◆ NO_COMMIT_FLAG

#define NO_COMMIT_FLAG   0x1 /* used in chlModDataObjMeta and chlRegDataObj */

Definition at line 128 of file objInfo.h.

◆ NO_STAGING

#define NO_STAGING   0

Definition at line 257 of file objInfo.h.

◆ NO_TRASH_CAN

#define NO_TRASH_CAN   1

Definition at line 264 of file objInfo.h.

◆ OLD_COPY

#define OLD_COPY   0x0

Definition at line 115 of file objInfo.h.

◆ OPEN_EXISTING_COPY

#define OPEN_EXISTING_COPY   0x10

Definition at line 117 of file objInfo.h.

◆ PRIMARY_FLAG

#define PRIMARY_FLAG   0x8000 /* primary class when this bit is set */

Definition at line 279 of file objInfo.h.

◆ STAGE_SRC

#define STAGE_SRC   1

Definition at line 258 of file objInfo.h.

◆ SYNC_DEST

#define SYNC_DEST   2

Definition at line 259 of file objInfo.h.

◆ TAR_BUNDLE_DT_STR

#define TAR_BUNDLE_DT_STR   "tar bundle"

Definition at line 35 of file objInfo.h.

◆ TAR_DT_STR

#define TAR_DT_STR   "tar file"

Definition at line 29 of file objInfo.h.

◆ TAR_STRUCT_FILE_STR

#define TAR_STRUCT_FILE_STR   "tarStructFile"

Definition at line 68 of file objInfo.h.

◆ UNMOUNT_STR

#define UNMOUNT_STR   "unmount"

Definition at line 75 of file objInfo.h.

◆ ZIP_BUNDLE_DT_STR

#define ZIP_BUNDLE_DT_STR   "zipFile bundle"

Definition at line 38 of file objInfo.h.

◆ ZIP_DT_STR

#define ZIP_DT_STR   "zipFile"

Definition at line 32 of file objInfo.h.

Typedef Documentation

◆ collInfo_t

typedef struct CollInfo collInfo_t

◆ dataObjInfo_t

typedef struct DataObjInfo dataObjInfo_t

◆ intArray_t

typedef struct IntArray intArray_t

◆ inxIvalPair_t

typedef struct InxIvalPair inxIvalPair_t

◆ inxValPair_t

typedef struct InxValPair inxValPair_t

◆ keyValPair_t

typedef struct KeyValPair keyValPair_t

◆ ruleInfo_t

typedef struct RuleInfo ruleInfo_t

◆ specColl_t

typedef struct SpecColl specColl_t

◆ specCollCache_t

◆ strArray_t

typedef struct StrArray strArray_t

◆ structFileTypeDef_t

◆ subFile_t

typedef struct Subfile subFile_t

◆ tagStruct_t

typedef struct TagStruct tagStruct_t

Enumeration Type Documentation

◆ createPath_t

Enumerator
NO_CREATE_PATH 
CREATE_PATH 

Definition at line 265 of file objInfo.h.

◆ rescCat_t

enum rescCat_t
Enumerator
FILE_CAT 
DB_CAT 

Definition at line 235 of file objInfo.h.

◆ specCollClass_t

Enumerator
NO_SPEC_COLL 
STRUCT_FILE_COLL 
MOUNTED_COLL 
LINKED_COLL 

Definition at line 45 of file objInfo.h.

◆ specCollPerm_t

Enumerator
UNKNOWN_COLL_PERM 
READ_COLL_PERM 
WRITE_COLL_PERM 

Definition at line 96 of file objInfo.h.

◆ structFileOprType_t

Enumerator
NOT_SPEC_COLL_OPR 
NON_STRUCT_FILE_SPEC_COLL_OPR 
STRUCT_FILE_SPEC_COLL_OPR 
NORMAL_OPR_ON_STRUCT_FILE_COLL 

Definition at line 59 of file objInfo.h.

◆ structFileType_t

Enumerator
NONE_STRUCT_FILE_T 
HAAW_STRUCT_FILE_T 
TAR_STRUCT_FILE_T 
MSSO_STRUCT_FILE_T 

Definition at line 52 of file objInfo.h.