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)  

Input Data Structures
Collaboration diagram for Input Data Structures:

Typedefs

typedef struct DataObjCopyInp dataObjCopyInp_t
 
typedef struct DataObjInp dataObjInp_t
 
typedef struct OpenedDataObjInp openedDataObjInp_t
 
typedef struct CollInp collInp_t
 
typedef struct FileLseekInp fileLseekInp_t
 
typedef struct BytesBuf bytesBuf_t
 

Detailed Description

Typedef Documentation

◆ bytesBuf_t

Description:\n general struct to store a buffer of bytes
Since
1.0
Remarks
none
Note
Elements of bytesBuf_t:
  • int len - the length of the allocated buffer in buf or the length of the data stored in buf depending on the application.
  • void *buf - pointer to the buffer.
See also
none

◆ collInp_t

Description:\n Input struct for collection operation
Since
1.0
Remarks
none
Note
Elements of collInp_t:
  • char collName[MAX_NAME_LEN] - full path of the collection.
  • int flags - Flags. Used only by rcOpenCollection.
  • int oprType - operation type. not used.
  • keyValPair_t condInput - keyword/value pair input. Valid keywords depend on the API.
See also
none

◆ dataObjCopyInp_t

Description:\n Input struct for Copy Data object operation
Since
1.0
Remarks
none
Note
Elements of dataObjCopyInp_t:
  • dataObjInp_t srcDataObjInp - dataObjInp_t for the source data object.
  • dataObjInp_t destDataObjInp - dataObjInp_t for the target data object.
See also
none

◆ dataObjInp_t

Description:\n Input struct for Data object operation
Since
1.0
Remarks
none
Note
Elements of dataObjInp_t:
  • char objPath[MAX_NAME_LEN] - full path of the data object.
  • int createMode - the file mode of the data object.
  • int openFlags - the flags for the I/O operation, Valid flags are O_RDONLY, O_WRONLY, O_RDWR and O_TRUNC. Also used for specCollInx in rcQuerySpecColl.
  • rodsLong_t offset - the offset.
  • rodsLong_t dataSize - the size of the data object.
  • int numThreads - the number of threads to use.
  • int oprType - the type of operation.
  • specColl_t *specColl - a pointer to a specColl_t if this path is in a special collection (e.g. mounted collection).
  • keyValPair_t condInput - keyword/value pair input. Valid keywords depend on the API.
See also
none

◆ fileLseekInp_t

Description:\n Input struct for rcDataObjLseek and rsFileLseek operations
Since
1.0
Remarks
none
Note
Elements of fileLseekInp_t:
  • int fileInx - the opened file descriptor from rcFileOpen or rcFileCreate.
  • rodsLong_t offset - the roffset
  • int whence - Similar to lseek of UNIX. Valid values are:
    SEEK_SET - The offset is set to offset bytes.
    SEEK_CUR - The offset is set to its current location plus offset bytes.
    SEEK_END - The offset is set to the size of the file plus offset bytes.
See also
none

◆ openedDataObjInp_t

Description:\n Input struct for Opened data object operation
Since
1.0
Remarks
none
Note
Elements of openedDataObjInp_t:
  • int l1descInx - the opened data object descriptor from rcDataObjOpen or rcDataObjCreate
  • int len - the length (number of bytes) to read/write.
  • int whence - valid only for rcDataObjLseek (similar to lseek of UNIX). Valid values are SEEK_SET, SEEK_CUR and SEEK_END.
  • int oprType - The operation type. Valid values are - PUT_OPR, GET_OPR, REPLICATE_OPR, ... See dataObjInpOut.h for more.
  • rodsLong_t offset - the offset.
  • rodsLong_t bytesWritten - Number of bytes written (valid for rcDataObjClose).
  • keyValPair_t condInput - keyword/value pair input. Valid keywords depend on the API.
See also
none