msiCreateXmsgInp ( msParam_t *  inMsgNumber,
msParam_t *  inMsgType,
msParam_t *  inNumberOfReceivers,
msParam_t *  inMsg,
msParam_t *  inNumberOfDeliverySites,
msParam_t *  inDeliveryAddressList,
msParam_t *  inDeliveryPortList,
msParam_t *  inMiscInfo,
msParam_t *  inXmsgTicketInfoParam,
msParam_t *  outSendXmsgInpParam,
ruleExecInfo_t *  rei 
)
Description:
Given all information values this microservice creates an Xmsg packet.
Module:
core
Since:
pre-2.1
Author:
Arcot Rajasekar
Date:
2008-05
Example Usage:
See clients/icommands/test/rules3.0/
Parameters:
[in] inMsgNumber - a msParam of type uint or STR_MS_T which is a message serial number.
[in] inMsgType - a msParam of type uint or STR_MS_T which is currently 0 (SINGLE_MSG_TICKET) or 1 (MULTI_MSG_TICKET).
[in] inNumberOfReceivers - a msParam of type uint or STR_MS_T which is a number of receivers of the message.
[in] inMsg - a msParam of type STR_MS_T which is a message body.
[in] inNumberOfDeliverySites - a msParam of type int or STR_MS_T which is a Number of Receiving Addresses.
[in] inDeliveryAddressList - a msParam of type STR_MS_T which is a List of Host Addresses (comma separated).
[in] inDeliveryPortList - a msParam of type STR_MS_T which is a List of Correspondng Ports (comma separated).
[in] inMiscInfo - a msParam of type STR_MS_T which is other Information.
[in] inXmsgTicketInfoParam - a msParam of type XmsgTicketInfo_MS_T which is outXmsgTicketInfoParam from msiXmsgCreateStream
[out] outSendXmsgInpParam - a msParam of type SendXmsgInp_MS_T which is a Xmsg packet.
[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:
none
Postcondition:
none
See also:
none

Definition at line 207 of file xmsgMS.c.

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