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 Rule Operations:

Functions

int rcExecMyRule (rcComm_t *conn, execMyRuleInp_t *execMyRuleInp, msParamArray_t **outParamArray)
 
int rcStreamClose (rcComm_t *conn, fileCloseInp_t *fileCloseInp)
 
int rcStreamRead (rcComm_t *conn, fileReadInp_t *streamReadInp, bytesBuf_t *streamReadOutBBuf)
 

Detailed Description

Function Documentation

◆ rcExecMyRule()

rcExecMyRule ( rcComm_t conn,
execMyRuleInp_t execMyRuleInp,
msParamArray_t **  outParamArray 
)
Description:\n Execute my rule.
Primary User:\n client
Since
1.0
Remarks
none
Note
none
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]execMyRuleInp
[out]outParamArray
Returns
integer
Return values
0on success.
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 36 of file rcExecMyRule.cpp.

References branchReadAndProcApiReply(), CL_GET_ACTION, CL_PUT_ACTION, clearKeyVal(), clearMsParamArray(), DataObjInp::condInput, EXEC_MY_RULE_AN, getMsParamByLabel(), getValByKey(), MsParam::inOutStruct, LOCAL_PATH_KW, LOG_DEBUG, LOG_ERROR, MAX_NAME_LEN, NULL, DataObjInp::objPath, procApiRequest(), rcDataObjGet(), rcDataObjPut(), rcOprComplete(), rodsLogError(), splitPathByKey(), irods.pypyodbc::status, SYS_SVR_TO_CLI_MSI_NO_EXIST, SYS_SVR_TO_CLI_MSI_REQUEST, and USER_FILE_DOES_NOT_EXIST.

Referenced by remoteExecMyRule().

Here is the call graph for this function:

◆ rcStreamClose()

rcStreamClose ( rcComm_t conn,
fileCloseInp_t fileCloseInp 
)
Description:\n Close an existing stream.
Primary User:\n client
Since
1.0
Remarks
none
Note
none
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 32 of file rcStreamClose.cpp.

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

Here is the call graph for this function:

◆ rcStreamRead()

rcStreamRead ( rcComm_t conn,
fileReadInp_t streamReadInp,
bytesBuf_t streamReadOutBBuf 
)
Description:\n Read an incoming stream.
Primary User:\n client
Since
1.0
Remarks
none
Note
none
Parameters
[in]conn- A rcComm_t connection handle to the server.
[in]streamReadInp
[out]streamReadOutBBuf
Returns
integer
Return values
0on success.
Side Effect:\n none
Precondition
none
Postcondition
none
See also
none

Definition at line 33 of file rcStreamRead.cpp.

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

Here is the call graph for this function: