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 Client Miscellaneous Operations:

Functions

int rcExecCmd (rcComm_t *conn, execCmd_t *execCmdInp, execCmdOut_t **execCmdOut)
 
int rcGetHostForGet (rcComm_t *conn, dataObjInp_t *dataObjInp, char **outHost)
 
int rcGetHostForPut (rcComm_t *conn, dataObjInp_t *dataObjInp, char **outHost)
 
int rcGetMiscSvrInfo (rcComm_t *conn, miscSvrInfo_t **outSvrInfo)
 
int rcOprComplete (rcComm_t *conn, int retval)
 
int rcProcStat (rcComm_t *conn, procStatInp_t *procStatInp, genQueryOut_t **procStatOut)
 

Detailed Description

Function Documentation

◆ rcExecCmd()

rcExecCmd ( rcComm_t conn,
execCmd_t execCmdInp,
execCmdOut_t **  execCmdOut 
)
Description:\n Execute a command on the server.
Primary User:\n client
Since
1.0
Remarks
none
Note
none
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]execCmdInp- the execCmd input
[out]execCmdOut- The stdout and stderr of the command is stored int this bytesBuf.
Returns
integer
Return values
0on success.
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 34 of file rcExecCmd.cpp.

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

Referenced by remoteExecCmd().

Here is the call graph for this function:

◆ rcGetHostForGet()

rcGetHostForGet ( rcComm_t conn,
dataObjInp_t dataObjInp,
char **  outHost 
)
Description:\n Get the best host for the get operation.
Primary User:\n client
Since
1.0
Remarks
none
Note
none
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]dataObjInp- generic dataObj input. Relevant items are:
objPath - the path of the target collection.
condInput - conditional Input
– REPL_NUM_KW - The replica number of the copy to upload.
– RESC_NAME_KW - The default destination resource. Only used to create a new file, no overwrite of existing files.
[out]outHost- the address of the best host.
Returns
integer
Return values
0on success.
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 41 of file rcGetHostForGet.cpp.

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

Referenced by redirectConnToRescSvr(), and rsGetHostForGet().

Here is the call graph for this function:

◆ rcGetHostForPut()

rcGetHostForPut ( rcComm_t conn,
dataObjInp_t dataObjInp,
char **  outHost 
)
Description:\n Get the best host for the 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]dataObjInp- generic dataObj input. Relevant items are:
objPath - Optional, the path of the target collection.
condInput - conditional Input
– FORCE_FLAG_KW - overwrite an existing data object
– ALL_KW - update all copies.
– REPL_NUM_KW - "value" = The replica number of the copy to upload.
– DEST_RESC_NAME_KW - "value" = The destination Resource.
– DEF_RESC_NAME_KW - "value" - The default dest resource. Only used to create a new file, no overwrite of existing files.
[out]outHost- the address of the best host.
Returns
integer
Return values
0on success.
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 44 of file rcGetHostForPut.cpp.

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

Referenced by redirectConnToRescSvr(), and rsGetHostForPut().

Here is the call graph for this function:

◆ rcGetMiscSvrInfo()

rcGetMiscSvrInfo ( rcComm_t conn,
miscSvrInfo_t **  outSvrInfo 
)
Description:\n Get miscellaneous server info.
Primary User:\n client
Since
1.0
Remarks
Get the connection stat of iRODS agents running in the iRODS federation. By default, the stat of the iRODS agents on the iCAT enabled server (IES) is listed. Other servers can be specified using the "addr" field of procStatInp or using the RESC_NAME_KW keyword.
Note
none
Parameters
[in]conn- A rcComm_t connection handle to the server.
[out]outSvrInfo- A struct that contains the requested info.
Returns
integer
Return values
0on success.
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 38 of file rcGetMiscSvrInfo.cpp.

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

Here is the call graph for this function:

◆ rcOprComplete()

rcOprComplete ( rcComm_t conn,
int  retval 
)
Description:\n Complete an operation.
Primary User:\n client
Since
1.0
Remarks
none
Note
none
Parameters
[in]conn- A rcComm_t connection handle to the server.
[out]retval
Returns
integer
Return values
0on success.
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 32 of file rcOprComplete.cpp.

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

Referenced by rcDataObjGet(), rcDataObjPut(), rcDataObjRsync(), rcExecMyRule(), and rsOprComplete().

Here is the call graph for this function:

◆ rcProcStat()

rcProcStat ( rcComm_t conn,
procStatInp_t procStatInp,
genQueryOut_t **  procStatOut 
)
Description:\n Get the status of a process.
Primary User:\n client
Since
1.0
Remarks
Get the connection stat of iRODS agents running in the iRODS federation. By default, the stat of the iRODS agents on the iCAT enabled server (IES) is listed. Other servers can be specified using the "addr" field of procStatInp or using the RESC_NAME_KW keyword.
Note
none
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]procStatInp
addr - the IP address of the server where the stat should be done. A zero length addr means no input.
rodsZone - the zone name for this stat. A zero length rodsZone means the stat is to be done in the local zone.
condInput - conditional Input
– RESC_NAME_KW - "value" - do the stat on the server where the Resource is located.
– ALL_KW (and zero len value) - stat for all servers in the federation.
[in]procStatOut- The procStatOut contains 9 attributes and value arrays with the attriInx defined above. i.e.:
– PID_INX - pid of the agent process
– STARTTIME_INX - The connection start time in secs since Epoch.
– CLIENT_NAME_INX - client user name
– CLIENT_ZONE_INX - client user zone
– PROXY_NAME_INX - proxy user name
– PROXY_ZONE_INX - proxy user zone
– REMOTE_ADDR_INX - the from address of the connection
– SERVER_ADDR_INX - the server address of the connection
– PROG_NAME_INX - the client program name


A row will be given for each running irods agent. If a server is completely idle, one row will still be given with all the attribute values empty (zero length string) except for the value associated with the SERVER_ADDR_INX.

Returns
integer
Return values
0on success.
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 57 of file rcProcStat.cpp.

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

Referenced by remoteProcStat().

Here is the call graph for this function: