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)  

Collaboration diagram for Server File Driver Operations:

Functions

int rcFileChksum (rcComm_t *conn, fileChksumInp_t *fileChksumInp, char **chksumStr)
 
int rcFileChmod (rcComm_t *conn, fileChmodInp_t *fileChmodInp)
 
int rcFileClose (rcComm_t *conn, fileCloseInp_t *fileCloseInp)
 
int rcFileClosedir (rcComm_t *conn, fileClosedirInp_t *fileClosedirInp)
 
int rcFileCreate (rcComm_t *conn, fileCreateInp_t *fileCreateInp, fileCreateOut_t **)
 
int rcFileGet (rcComm_t *conn, fileOpenInp_t *fileGetInp, bytesBuf_t *fileGetOutBBuf)
 
int rcFileGetFsFreeSpace (rcComm_t *conn, fileGetFsFreeSpaceInp_t *fileGetFsFreeSpaceInp, fileGetFsFreeSpaceOut_t **fileGetFsFreeSpaceOut)
 
int rcFileLseek (rcComm_t *conn, fileLseekInp_t *fileLseekInp, fileLseekOut_t **fileLseekOut)
 
int rcFileMkdir (rcComm_t *conn, fileMkdirInp_t *fileMkdirInp)
 
int rcFileOpen (rcComm_t *conn, fileOpenInp_t *fileOpenInp)
 
int rcFileOpendir (rcComm_t *conn, fileOpendirInp_t *fileOpendirInp)
 
int rcFilePut (rcComm_t *conn, fileOpenInp_t *filePutInp, bytesBuf_t *filePutInpBBuf, filePutOut_t **)
 
int rcFileRead (rcComm_t *conn, fileReadInp_t *fileReadInp, bytesBuf_t *fileReadOutBBuf)
 
int rcFileReaddir (rcComm_t *conn, fileReaddirInp_t *fileReaddirInp, rodsDirent_t **fileReaddirOut)
 
int rcFileRename (rcComm_t *conn, fileRenameInp_t *fileRenameInp, fileRenameOut_t **)
 
int rcFileRmdir (rcComm_t *conn, fileRmdirInp_t *fileRmdirInp)
 
int rcFileStageToCache (rcComm_t *conn, fileStageSyncInp_t *fileStageToCacheInp)
 
int rcFileStat (rcComm_t *conn, fileStatInp_t *fileStatInp, rodsStat_t **fileStatOut)
 
int rcFileSyncToArch (rcComm_t *conn, fileStageSyncInp_t *fileSyncToArchInp, fileSyncOut_t **)
 
int rcFileTruncate (rcComm_t *conn, fileOpenInp_t *fileTruncateInp)
 
int rcFileUnlink (rcComm_t *conn, fileUnlinkInp_t *fileUnlinkInp)
 
int rcFileWrite (rcComm_t *conn, fileWriteInp_t *fileWriteInp, bytesBuf_t *fileWriteInpBBuf)
 

Detailed Description

Function Documentation

◆ rcFileChksum()

rcFileChksum ( rcComm_t conn,
fileChksumInp_t fileChksumInp,
char **  chksumStr 
)
Description:\n Calculate a checksum on a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileChksumInp
[out]chksumStr- the checksum
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileChksum.cpp.

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

Referenced by remoteFileChksum().

Here is the call graph for this function:

◆ rcFileChmod()

rcFileChmod ( rcComm_t conn,
fileChmodInp_t fileChmodInp 
)
Description:\n Changes mode on a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileChmodInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcFileChmod.cpp.

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

Referenced by remoteFileChmod().

Here is the call graph for this function:

◆ rcFileClose()

rcFileClose ( rcComm_t conn,
fileCloseInp_t fileCloseInp 
)
Description:\n Closes a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileCloseInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcFileClose.cpp.

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

Referenced by remoteExecCmd(), and remoteFileClose().

Here is the call graph for this function:

◆ rcFileClosedir()

rcFileClosedir ( rcComm_t conn,
fileClosedirInp_t fileClosedirInp 
)
Description:\n Close a directory.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileClosedirInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcFileClosedir.cpp.

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

Referenced by remoteFileClosedir().

Here is the call graph for this function:

◆ rcFileCreate()

rcFileCreate ( rcComm_t conn,
fileCreateInp_t fileCreateInp,
fileCreateOut_t **  _out 
)
Description:\n Register a data object.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileCreateInp
[out]_out
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileCreate.cpp.

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

Referenced by remoteFileCreate().

Here is the call graph for this function:

◆ rcFileGet()

rcFileGet ( rcComm_t conn,
fileOpenInp_t fileGetInp,
bytesBuf_t fileGetOutBBuf 
)
Description:\n Get a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileGetInp
[out]fileGetOutBBuf- the out buffer
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileGet.cpp.

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

Referenced by remoteFileGet().

Here is the call graph for this function:

◆ rcFileGetFsFreeSpace()

rcFileGetFsFreeSpace ( rcComm_t conn,
fileGetFsFreeSpaceInp_t fileGetFsFreeSpaceInp,
fileGetFsFreeSpaceOut_t **  fileGetFsFreeSpaceOut 
)
Description:\n Gets filesystem free space.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileGetFsFreeSpaceInp
[out]fileGetFsFreeSpaceOut
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileGetFsFreeSpace.cpp.

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

Referenced by remoteFileGetFsFreeSpace().

Here is the call graph for this function:

◆ rcFileLseek()

rcFileLseek ( rcComm_t conn,
fileLseekInp_t fileLseekInp,
fileLseekOut_t **  fileLseekOut 
)
Description:\n Left seek within a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileLseekInp
[out]fileLseekOut
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileLseek.cpp.

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

Referenced by remoteFileLseek().

Here is the call graph for this function:

◆ rcFileMkdir()

rcFileMkdir ( rcComm_t conn,
fileMkdirInp_t fileMkdirInp 
)
Description:\n Make a directory.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileMkdirInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcFileMkdir.cpp.

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

Referenced by remoteFileMkdir().

Here is the call graph for this function:

◆ rcFileOpen()

rcFileOpen ( rcComm_t conn,
fileOpenInp_t fileOpenInp 
)
Description:\n Open a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileOpenInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcFileOpen.cpp.

References FILE_OPEN_AN, fileOpenInp_t::flags, NULL, procApiRequest(), and irods.pypyodbc::status.

Referenced by remoteFileOpen().

Here is the call graph for this function:

◆ rcFileOpendir()

rcFileOpendir ( rcComm_t conn,
fileOpendirInp_t fileOpendirInp 
)
Description:\n Open a directory.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileOpendirInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcFileOpendir.cpp.

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

Referenced by remoteFileOpendir().

Here is the call graph for this function:

◆ rcFilePut()

rcFilePut ( rcComm_t conn,
fileOpenInp_t filePutInp,
bytesBuf_t filePutInpBBuf,
filePutOut_t **  put_out 
)
Description:\n Basic file put operation.
Primary User:\n client
Since
1.0
Remarks
none
Note
none
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]filePutInp
[in]filePutInpBBuf- buffer containing the file's contents
[out]put_out
Returns
integer
Return values
0on success.
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 33 of file rcFilePut.cpp.

References FILE_PUT_AN, fileOpenInp_t::flags, NULL, procApiRequest(), and irods.pypyodbc::status.

Referenced by remoteFilePut().

Here is the call graph for this function:

◆ rcFileRead()

rcFileRead ( rcComm_t conn,
fileReadInp_t fileReadInp,
bytesBuf_t fileReadOutBBuf 
)
Description:\n Read a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileReadInp
[out]fileReadOutBBuf- the file buffer
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileRead.cpp.

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

Referenced by remoteFileRead().

Here is the call graph for this function:

◆ rcFileReaddir()

rcFileReaddir ( rcComm_t conn,
fileReaddirInp_t fileReaddirInp,
rodsDirent_t **  fileReaddirOut 
)
Description:\n Reads a file directory.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileReaddirInp
[out]fileReaddirOut
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileReaddir.cpp.

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

Referenced by remoteFileReaddir().

Here is the call graph for this function:

◆ rcFileRename()

rcFileRename ( rcComm_t conn,
fileRenameInp_t fileRenameInp,
fileRenameOut_t **  _out 
)
Description:\n Renames a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileRenameInp
[out]_out- the output
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileRename.cpp.

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

Referenced by remoteFileRename().

Here is the call graph for this function:

◆ rcFileRmdir()

rcFileRmdir ( rcComm_t conn,
fileRmdirInp_t fileRmdirInp 
)
Description:\n Remove a directory.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileRmdirInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcFileRmdir.cpp.

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

Referenced by remoteFileRmdir().

Here is the call graph for this function:

◆ rcFileStageToCache()

rcFileStageToCache ( rcComm_t conn,
fileStageSyncInp_t fileStageToCacheInp 
)
Description:\n Stage a file from the archive to the cache.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileStageToCacheInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcFileStageToCache.cpp.

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

Referenced by remoteFileStageToCache().

Here is the call graph for this function:

◆ rcFileStat()

rcFileStat ( rcComm_t conn,
fileStatInp_t fileStatInp,
rodsStat_t **  fileStatOut 
)
Description:\n Stat a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileStatInp
[out]fileStatOut- the stat output
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileStat.cpp.

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

Referenced by remoteFileStat(), and statPhysFile().

Here is the call graph for this function:

◆ rcFileSyncToArch()

rcFileSyncToArch ( rcComm_t conn,
fileStageSyncInp_t fileSyncToArchInp,
fileSyncOut_t **  _fn 
)
Description:\n Syncs a file from cache back to archive.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileSyncToArchInp
[out]_fn- the filename
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileSyncToArch.cpp.

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

Referenced by remoteFileSyncToArch().

Here is the call graph for this function:

◆ rcFileTruncate()

rcFileTruncate ( rcComm_t conn,
fileOpenInp_t fileTruncateInp 
)
Description:\n Truncate a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileTruncateInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcFileTruncate.cpp.

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

Referenced by remoteFileTruncate().

Here is the call graph for this function:

◆ rcFileUnlink()

rcFileUnlink ( rcComm_t conn,
fileUnlinkInp_t fileUnlinkInp 
)
Description:\n Unlink a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileUnlinkInp
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 23 of file rcFileUnlink.cpp.

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

Referenced by remoteFileUnlink().

Here is the call graph for this function:

◆ rcFileWrite()

rcFileWrite ( rcComm_t conn,
fileWriteInp_t fileWriteInp,
bytesBuf_t fileWriteInpBBuf 
)
Description:\n Write a file.
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]fileWriteInp- the file input
[out]fileWriteInpBBuf- the input buffer
Returns
integer
Return values
0on success
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 24 of file rcFileWrite.cpp.

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

Referenced by remoteFileWrite().

Here is the call graph for this function: