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)  

Server Structured File (e.g. tar) Operations
Collaboration diagram for Server Structured File (e.g. tar) Operations:

Functions

int rcStructFileBundle (rcComm_t *conn, structFileExtAndRegInp_t *structFileBundleInp)
 
int rcStructFileExtAndReg (rcComm_t *conn, structFileExtAndRegInp_t *structFileExtAndRegInp)
 
int rcStructFileExtract (rcComm_t *conn, structFileOprInp_t *structFileOprInp)
 
int rcStructFileSync (rcComm_t *conn, structFileOprInp_t *structFileOprInp)
 
int rcSubStructFileClose (rcComm_t *conn, subStructFileFdOprInp_t *subStructFileCloseInp)
 
int rcSubStructFileClosedir (rcComm_t *conn, subStructFileFdOprInp_t *subStructFileClosedirInp)
 
int rcSubStructFileCreate (rcComm_t *conn, subFile_t *subFile)
 
int rcSubStructFileGet (rcComm_t *conn, subFile_t *subFile, bytesBuf_t *subFileGetOutBBuf)
 
int rcSubStructFileLseek (rcComm_t *conn, subStructFileLseekInp_t *subStructFileLseekInp, fileLseekOut_t **subStructFileLseekOut)
 
int rcSubStructFileMkdir (rcComm_t *conn, subFile_t *subFile)
 
int rcSubStructFileOpen (rcComm_t *conn, subFile_t *subFile)
 
int rcSubStructFileOpendir (rcComm_t *conn, subFile_t *subFile)
 
int rcSubStructFilePut (rcComm_t *conn, subFile_t *subFile, bytesBuf_t *subFilePutOutBBuf)
 
int rcSubStructFileRead (rcComm_t *conn, subStructFileFdOprInp_t *subStructFileReadInp, bytesBuf_t *subStructFileReadOutBBuf)
 
int rcSubStructFileReaddir (rcComm_t *conn, subStructFileFdOprInp_t *subStructFileReaddirInp, rodsDirent_t **rodsDirent)
 
int rcSubStructFileRename (rcComm_t *conn, subStructFileRenameInp_t *subStructFileRenameInp)
 
int rcSubStructFileRmdir (rcComm_t *conn, subFile_t *subFile)
 
int rcSubStructFileStat (rcComm_t *conn, subFile_t *subFile, rodsStat_t **subStructFileStatOut)
 
int rcSubStructFileTruncate (rcComm_t *conn, subFile_t *subStructFileTruncateInp)
 
int rcSubStructFileUnlink (rcComm_t *conn, subFile_t *subFile)
 
int rcSubStructFileWrite (rcComm_t *conn, subStructFileFdOprInp_t *subStructFileWriteInp, bytesBuf_t *subStructFileWriteOutBBuf)
 

Detailed Description

Function Documentation

◆ rcStructFileBundle()

rcStructFileBundle ( rcComm_t conn,
structFileExtAndRegInp_t structFileBundleInp 
)
Description:\n Bundle a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]structFileBundleInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcStructFileBundle.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and STRUCT_FILE_BUNDLE_AN.

Referenced by bunUtil(), remoteStructFileBundle(), and rsStructFileBundle().

Here is the call graph for this function:

◆ rcStructFileExtAndReg()

rcStructFileExtAndReg ( rcComm_t conn,
structFileExtAndRegInp_t structFileExtAndRegInp 
)
Description:\n Extract and register a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]structFileExtAndRegInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcStructFileExtAndReg.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and STRUCT_FILE_EXT_AND_REG_AN.

Referenced by bunUtil(), and rsStructFileExtAndReg().

Here is the call graph for this function:

◆ rcStructFileExtract()

rcStructFileExtract ( rcComm_t conn,
structFileOprInp_t structFileOprInp 
)
Description:\n Extract a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]structFileOprInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcStructFileExtract.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and STRUCT_FILE_EXTRACT_AN.

Referenced by remoteStructFileExtract(), and rsStructFileExtract().

Here is the call graph for this function:

◆ rcStructFileSync()

rcStructFileSync ( rcComm_t conn,
structFileOprInp_t structFileOprInp 
)
Description:\n Sync a structured file object with its extracted subfiles.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]structFileOprInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcStructFileSync.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and STRUCT_FILE_SYNC_AN.

Referenced by remoteStructFileSync().

Here is the call graph for this function:

◆ rcSubStructFileClose()

rcSubStructFileClose ( rcComm_t conn,
subStructFileFdOprInp_t subStructFileCloseInp 
)
Description:\n Close a previously opened subfile of a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subStructFileCloseInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcSubStructFileClose.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_CLOSE_AN.

Referenced by remoteSubStructFileClose().

Here is the call graph for this function:

◆ rcSubStructFileClosedir()

rcSubStructFileClosedir ( rcComm_t conn,
subStructFileFdOprInp_t subStructFileClosedirInp 
)
Description:\n Close a sub directory of a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subStructFileClosedirInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcSubStructFileClosedir.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_CLOSEDIR_AN.

Referenced by remoteSubStructFileClosedir().

Here is the call graph for this function:

◆ rcSubStructFileCreate()

rcSubStructFileCreate ( rcComm_t conn,
subFile_t subFile 
)
Description:\n Create a subfile of a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subFile
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcSubStructFileCreate.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_CREATE_AN.

Referenced by remoteSubStructFileCreate().

Here is the call graph for this function:

◆ rcSubStructFileGet()

rcSubStructFileGet ( rcComm_t conn,
subFile_t subFile,
bytesBuf_t subFileGetOutBBuf 
)
Description:\n Get a subfile of a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subFile
[out]subFileGetOutBBuf
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcSubStructFileGet.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_GET_AN.

Referenced by remoteSubStructFileGet().

Here is the call graph for this function:

◆ rcSubStructFileLseek()

rcSubStructFileLseek ( rcComm_t conn,
subStructFileLseekInp_t subStructFileLseekInp,
fileLseekOut_t **  subStructFileLseekOut 
)
Description:\n Seek within a subfile of a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subStructFileLseekInp
[out]subStructFileLseekOut
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcSubStructFileLseek.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_LSEEK_AN.

Referenced by remoteSubStructFileLseek().

Here is the call graph for this function:

◆ rcSubStructFileMkdir()

rcSubStructFileMkdir ( rcComm_t conn,
subFile_t subFile 
)
Description:\n Make a subdirectory within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subFile
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcSubStructFileMkdir.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_MKDIR_AN.

Referenced by remoteSubStructFileMkdir().

Here is the call graph for this function:

◆ rcSubStructFileOpen()

rcSubStructFileOpen ( rcComm_t conn,
subFile_t subFile 
)
Description:\n Open a subfile within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subFile
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcSubStructFileOpen.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_OPEN_AN.

Referenced by remoteSubStructFileOpen().

Here is the call graph for this function:

◆ rcSubStructFileOpendir()

rcSubStructFileOpendir ( rcComm_t conn,
subFile_t subFile 
)
Description:\n Open a subdirectory within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subFile
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcSubStructFileOpendir.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_OPENDIR_AN.

Referenced by remoteSubStructFileOpendir().

Here is the call graph for this function:

◆ rcSubStructFilePut()

rcSubStructFilePut ( rcComm_t conn,
subFile_t subFile,
bytesBuf_t subFilePutOutBBuf 
)
Description:\n Put a subfile within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subFile
[out]subFilePutOutBBuf
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcSubStructFilePut.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_PUT_AN.

Referenced by remoteSubStructFilePut().

Here is the call graph for this function:

◆ rcSubStructFileRead()

rcSubStructFileRead ( rcComm_t conn,
subStructFileFdOprInp_t subStructFileReadInp,
bytesBuf_t subStructFileReadOutBBuf 
)
Description:\n Read a subfile within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subStructFileReadInp
[out]subStructFileReadOutBBuf
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcSubStructFileRead.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_READ_AN.

Referenced by remoteSubStructFileRead().

Here is the call graph for this function:

◆ rcSubStructFileReaddir()

rcSubStructFileReaddir ( rcComm_t conn,
subStructFileFdOprInp_t subStructFileReaddirInp,
rodsDirent_t **  rodsDirent 
)
Description:\n Read a subdirectory within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subStructFileReaddirInp
[out]rodsDirent
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcSubStructFileReaddir.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_READDIR_AN.

Referenced by remoteSubStructFileReaddir().

Here is the call graph for this function:

◆ rcSubStructFileRename()

rcSubStructFileRename ( rcComm_t conn,
subStructFileRenameInp_t subStructFileRenameInp 
)
Description:\n Rename a subfile within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subStructFileRenameInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcSubStructFileRename.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_RENAME_AN.

Referenced by remoteSubStructFileRename().

Here is the call graph for this function:

◆ rcSubStructFileRmdir()

rcSubStructFileRmdir ( rcComm_t conn,
subFile_t subFile 
)
Description:\n Remove a subdirectory within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subFile
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcSubStructFileRmdir.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_RMDIR_AN.

Referenced by remoteSubStructFileRmdir().

Here is the call graph for this function:

◆ rcSubStructFileStat()

rcSubStructFileStat ( rcComm_t conn,
subFile_t subFile,
rodsStat_t **  subStructFileStatOut 
)
Description:\n Stat a subfile within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subFile
[out]subStructFileStatOut
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcSubStructFileStat.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_STAT_AN.

Referenced by remoteSubStructFileStat().

Here is the call graph for this function:

◆ rcSubStructFileTruncate()

rcSubStructFileTruncate ( rcComm_t conn,
subFile_t bunSubTruncateInp 
)
Description:\n Truncate a subfile within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]bunSubTruncateInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcSubStructFileTruncate.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_TRUNCATE_AN.

Referenced by remoteSubStructFileTruncate().

Here is the call graph for this function:

◆ rcSubStructFileUnlink()

rcSubStructFileUnlink ( rcComm_t conn,
subFile_t subFile 
)
Description:\n Unlink a subfile within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subFile
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcSubStructFileUnlink.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_UNLINK_AN.

Referenced by remoteSubStructFileUnlink().

Here is the call graph for this function:

◆ rcSubStructFileWrite()

rcSubStructFileWrite ( rcComm_t conn,
subStructFileFdOprInp_t subStructFileWriteInp,
bytesBuf_t subStructFileWriteOutBBuf 
)
Description:\n Write to a subfile within a structured file object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]subStructFileWriteInp
[out]subStructFileWriteOutBBuf
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcSubStructFileWrite.cpp.

References NULL, procApiRequest(), irods.pypyodbc::status, and SUB_STRUCT_FILE_WRITE_AN.

Referenced by remoteSubStructFileWrite().

Here is the call graph for this function: