writeXMsg ( msParam_t *  inStreamId,
msParam_t *  inHdr,
msParam_t *  inMsg,
ruleExecInfo_t *  rei 
)
Description:
This microservice writes a given string into an XMsgStream
Module:
core
Since:
2.4
Author:
Arcot Rajasekar
Date:
2010
Note:
This microservice takes a given buffer string and sends it as a message packet to 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 micro-serice or a supported standard stream with ids 1 thru 5
[in] inHdr - of type STR_MS_T - header string to be sent in the message packet
[in] inMsg - of type STR_MS_T - message string to be sent in the message 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:
an Xmsg gets sent and queued in the Xmsg server
Returns:
integer
Return values:
0 on success
Precondition:
none
Postcondition:
none
See also:
msiXmsgCreateStream, readXMsg

Definition at line 533 of file printMS.c.

Generated on Thu Nov 14 16:43:27 2013 for iRODS Documentation by  doxygen 1.6.3