readXMsg ( msParam_t *  inStreamId,
msParam_t *  inCondRead,
msParam_t *  outMsgNum,
msParam_t *  outSeqNum,
msParam_t *  outHdr,
msParam_t *  outMsg,
msParam_t *  outUser,
msParam_t *  outAddr,
ruleExecInfo_t *  rei 
)
Description:
Reads a message packet from an XMsgStream
Module:
core
Since:
2.4
Author:
Arcot Rajasekar
Date:
2010
Note:
Reads into buffer a message packet from the XMsg Server
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] inStreamId - of type STR_MS_T or INT_MAS_T - the XMsg streamId number possibly generated by a msiXmsgCreateStream microservice or a supported standard stream with ids 1 thru 5
[in] inCondRead - of type STR_MS_T - boolean condition for a packet to satisfy and the first packet that satisfies the condition is read from the XMsg Stream
[out] outMsgNum - of type INT_MS_T - message number of the incoming packet (as given by message source)
[out] outSeqNum - of type INT_MS_T - sequence number of the incoming packet (as given by Xmsg Server)
[out] outHdr - of type STR_MS_T - header string of the incoming message packet
[out] outMsg - of type STR_MS_T - message string of the incoming message packet
[out] outUser - of type STR_MS_T - userName of the sender of the packet
[out] outAddr - of type STR_MS_T - address of the sending site of the packet (host address and process-id)
[in,out] rei - The RuleExecInfo structure that is automatically handled by the rule engine. The user does not include rei as a parameter in the rule invocation.
Session Variables Used:
none
Session Variables Modified:
none
iCAT Attributes Used:
none
iCAT Attributes Modified:
none
Side Effect:
message packet may have its status changed in the XMsg Server
Returns:
integer
Return values:
0 on success
Precondition:
none
Postcondition:
none
See also:
msiXmsgCreateStream, writeXMsg

Definition at line 602 of file printMS.c.

Generated on Sat Nov 16 22:18:04 2013 for iRODS Documentation by  doxygen 1.6.3