msiRcvXmsg ( msParam_t *  inConnParam,
msParam_t *  inTicketNumber,
msParam_t *  inMsgNumber,
msParam_t *  outMsgType,
msParam_t *  outMsg,
msParam_t *  outSendUser,
ruleExecInfo_t *  rei 
)
Description:
This microservice receives an Xmsg packet.
Module:
core
Since:
pre-2.1
Author:
Arcot Rajasekar
Date:
2008-05
Note:
Uses the connection made by msiXmsgServerConnect.
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] inConnParam - a msParam of type RcComm_MS_T which is a connection descriptor obtained by msiXmsgServerConnect.
[in] inTicketNumber - a msParam of type XmsgTicketInfo_MS_T or STR_MS_T or unit which is outXmsgTicketInfoParam from msiXmsgCreateStream or outXmsgTicketInfoParam->rcvTicket (a string which the sender passes to the receiver).
[in] inMsgNumber - a msParam of type unit or STR_MS_T which is a message serial number to fetch.
[out] outMsgType - a msParam of type STR_MS_T which is a message type.
[out] outMsg - a msParam of type STR_MS_T which is a message body.
[out] outSendUser - a msParam of type STR_MS_T which is a sender information.
[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:
none
Returns:
integer
Return values:
0 on success
Precondition:
msiXmsgServerConnect should've been done earlier to get the inConnParam.
Postcondition:
none
See also:
none

Definition at line 378 of file xmsgMS.c.

Generated on Tue Nov 12 23:18:34 2013 for iRODS Documentation by  doxygen 1.6.3