Functions | |
MQERETURN | mqeMQMessage_new (MQeExceptBlock *pErrStruct, MQeMQMessageHndl *phMsgObj) |
Create a new MQeMQMessage object. | |
MQERETURN | mqeMQMessage_free (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct) |
Frees the resources associated with the MQeMQMessage. | |
MQERETURN | mqeMQMessage_getReport (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pReport) |
This function returns the value of the Report header field. | |
MQERETURN | mqeMQMessage_getMessageType (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pMessageType) |
This function returns the value of the MsgType header field. | |
MQERETURN | mqeMQMessage_getExpiry (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pExpiry) |
This function returns the value of the Expiry header field. The value is in tenths of a second, as is used in MQSeries messages (it is not in milliseconds, which is used for the MQSeries Everyplace expiry time). *. | |
MQERETURN | mqeMQMessage_getFeedback (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pFeedback) |
This function returns the value of the Feedback header field. | |
MQERETURN | mqeMQMessage_getEncoding (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pEncoding) |
This function returns the value of the Encoding header field. | |
MQERETURN | mqeMQMessage_getCharacterSet (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pCharacterSet) |
This function returns the value of the CodedCharSetId header field. | |
MQERETURN | mqeMQMessage_getFormat (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phFormat) |
MQERETURN | mqeMQMessage_getPriority (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pPriority) |
This function returns the value of the Priority header field. | |
MQERETURN | mqeMQMessage_getPersistence (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pPersistence) |
This function returns the value of the Persistence header field. | |
MQERETURN | mqeMQMessage_getMessageId (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBYTE *pMessageId, MQEUINT32 *pSize) |
This function returns the value of the MsgID header field. | |
MQERETURN | mqeMQMessage_getCorrelationId (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBYTE *pCorrelationID, MQEUINT32 *pSize) |
This function returns the value of the CorrelId header field. | |
MQERETURN | mqeMQMessage_getBackoutCount (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pBackoutCount) |
This function returns the value of the BackoutCount header field. | |
MQERETURN | mqeMQMessage_getReplyToQueueName (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phReplyQueueName) |
This function returns the value of the ReplyToQ header field. | |
MQERETURN | mqeMQMessage_getReplyToQueueManagerName (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phReplyQueueManagerName) |
This function returns the value of the ReplyToQMgr header field. | |
MQERETURN | mqeMQMessage_getUserId (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phUserId) |
This function returns the value of the UserIdentifier header field. | |
MQERETURN | mqeMQMessage_getAccountingToken (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBYTE *pAccoutingToken, MQEUINT32 *pSize) |
This function returns the value of the AccountingToken header field. | |
MQERETURN | mqeMQMessage_getApplicationIdData (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phApplicationIDData) |
This function returns the value of the ApplIdentityData header field. | |
MQERETURN | mqeMQMessage_getPutApplicationType (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pApplicatoinType) |
This function returns the value of the PutApplType header field. | |
MQERETURN | mqeMQMessage_getPutApplicationName (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phApplicationName) |
This function returns the value of the PutApplName header field. | |
MQERETURN | mqeMQMessage_getApplicationOriginData (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phAplicationOriginData) |
This function returns the value of the ApplOriginData header field. | |
MQERETURN | mqeMQMessage_getGroupId (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBYTE *pGroupID, MQEUINT32 *pSize) |
This function returns the value of the group id header field. | |
MQERETURN | mqeMQMessage_getPutDateTime (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT64 *pTime) |
This function returns the value of the PutDate and PutTime header fields. This value is returned as a number of milliseconds since epoc. | |
MQERETURN | mqeMQMessage_getMessageSequenceNumber (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pSequenceNumber) |
This function sets the value of the MsgSeqNumber header field in the MQSeries style message. | |
MQERETURN | mqeMQMessage_getOffset (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pOffSet) |
This function returns the value of the Offset header field. | |
MQERETURN | mqeMQMessage_getMessageFlags (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pMessageFlags) |
This function returns the value of the MsgFlags header field. | |
MQERETURN | mqeMQMessage_getOriginalLength (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pOrignalLength) |
This function returns the value of the OriginalLength header field. | |
MQERETURN | mqeMQMessage_getData (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBYTE *pData, MQEINT32 *pSize) |
This function returns the message data. The application must know how to interpret the data. | |
MQERETURN | mqeMQMessage_setReport (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 report) |
This function sets the value of the Report header field in the MQSeries style message. | |
MQERETURN | mqeMQMessage_setMessageType (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 messageType) |
This function sets the value of the MsgSeqNumber header field in the MQSeries style message. | |
MQERETURN | mqeMQMessage_setExpiry (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 expiry) |
This function sets the value of the Expiry header field in the MQSeries style message. It also sets the expiry time of the message for use within the MQSeries Everyplace system itself. | |
MQERETURN | mqeMQMessage_setFeedback (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 feedback) |
This function sets the value of the Feedback header field in the MQSeries style message. | |
MQERETURN | mqeMQMessage_setEncoding (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 encoding) |
This function sets the value of the Encoding header field in the MQSeries style message. | |
MQERETURN | mqeMQMessage_setCharacterSet (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 characterSet) |
This function sets the value of the CodedCharSetId header field in the MQSeries style message. | |
MQERETURN | mqeMQMessage_setFormat (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hFormat) |
This function sets the value of the Format header field in the MQSeries style message. | |
MQERETURN | mqeMQMessage_setPriority (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 priority) |
This function sets the value of the Priority header field in the MQSeries style message. It also sets the priority of the message for use within the MQSeries Everyplace system itself. | |
MQERETURN | mqeMQMessage_setPersistence (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 persistence) |
This function sets the value of the Persistence header field in the MQSeries style message. | |
MQERETURN | mqeMQMessage_setMessageId (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBYTE *pMessageId, MQEUINT32 size) |
This function sets the value of the MsgId header field in the MQSeries style message. | |
MQERETURN | mqeMQMessage_setCorrelationId (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBYTE *pCorrelationId, MQEUINT32 size) |
This function sets the value of the CorrelId header field in the MQSeries style message. It also sets the Correlation ID for use within the MQSeries Everyplace system itself. | |
MQERETURN | mqeMQMessage_setBackoutCount (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 backoutCount) |
This function sets the value of the BackoutCount header field in the MQSeries style message. | |
MQERETURN | mqeMQMessage_setReplyToQueueName (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hReplyToQueueName) |
This function sets the reply-to queue Name in the message header. | |
MQERETURN | mqeMQMessage_setReplyToQueueManagerName (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hReplyToQMName) |
This function sets the reply-to queue manager name in the message header. | |
MQERETURN | mqeMQMessage_setUserId (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hUserId) |
This function sets the user ID in the message header. | |
MQERETURN | mqeMQMessage_setAccountingToken (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBYTE *pAccountingToken, MQEUINT32 size) |
This function sets the value of the accounting token in the message header. | |
MQERETURN | mqeMQMessage_setApplicationIdData (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hApplicationIdData) |
This function sets the application ID data in the message header. | |
MQERETURN | mqeMQMessage_setPutApplicationType (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 putApplicationType) |
This function sets the put application type in the message header. | |
MQERETURN | mqeMQMessage_setPutApplicationName (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hPutApplicationName) |
This function sets the put application name in the message header. | |
MQERETURN | mqeMQMessage_setApplicationOriginData (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hApplicationOriginData) |
This function sets the application origin data in the message header. | |
MQERETURN | mqeMQMessage_setGroupId (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBYTE *pGroupId, MQEUINT32 size) |
This function sets the value of the group ID in the message header. | |
MQERETURN | mqeMQMessage_setPutDateTime (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT64 time) |
This function sets the put date and time in the message header. | |
MQERETURN | mqeMQMessage_setMessageSequenceNumber (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 seqNo) |
This function sets the message sequence number in the message header. | |
MQERETURN | mqeMQMessage_setOffset (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 offset) |
This function sets the value of the offset in the message header. | |
MQERETURN | mqeMQMessage_setMessageFlags (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 flags) |
This function sets the value of the message flags in the message header. | |
MQERETURN | mqeMQMessage_setOriginalLength (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 len) |
This function sets the original length in the message header. | |
MQERETURN | mqeMQMessage_setData (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEBYTE *pData, MQEUINT32 size) |
This function sets the message data. | |
MQERETURN | mqeMQMessage_equals (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStructbyte, MQEBYTE *pFirstArray, MQEINT32 firstArraySize, MQEBYTE *pSecondArray, MQEINT32 secondArraySize, MQEBOOL *pEquality) |
This function compares to byte arrays for equality. | |
MQERETURN | mqeMQMessage_dumpToString (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phString) |
This function dumps the field values in the message object to an MQSeries Everyplace string. | |
MQERETURN | mqeMQMessage_dumpAllToString (MQeMQMessageHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phString) |
This function dumps all the field values from the message to an MQSeries Everyplace string. |
This section describes the object used to represent an MQSeries style message object within MQSeries Everyplace. It can be used to create and read MQSeriess style message objects. The class has getxxx() and setxxx() methods for all the MQSeries message header fields. For efficiency however, only fields that have been set to a non-default value are actually contained in the message object .
This class represents an MQSeries style message. It is designed for use with messages that flow between MQSeries and MQSeries Everyplace applications and use the MQSeries message format, i.e. 'system information' is stored in fields in a header section and the user data is stored in a byte array.
The default message transformer in the MQSeries-bridge creates an MQeMQMsgObject when it transforms an MQSeries message that is not marked as being in MQSeries Everyplace format.
If an MQeMQMsgObject arrives at the Bridge from MQe, the default message transformer maps the message header values and data directly into an MQSeries message.
This class should not make any references to the MQSeries Java classes (MQeMQMessageHndl hMsgObj,MQeExceptBlock *pErrStructcom.ibm.mq.*);. This class is used on clients that receive MQSeries formatted messages via the bridge, and we don't want any references to the MQSeries Java Classes on the client.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
A String containing the format value
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|