 |
|
|
|
||||
|
|||||
|
|
|||||
ommqi IBM MQSeries Object Descriptions |
|||||
This page describes the mechanism for representing IBM MQSeries structures in the OmniMark MQSeries interface.
For further documentation on the meanings of the structure fields and on their use please see the documentation that came with IBM MQSeries.
Each MQSeries structure that is supported in the OmniMark interface is listed below. Each subsection has the following form:
Getter functions take an OmniMark MQSeries opaque and a modifiable shelf. The getter function populates the shelf with key {field} and the field value for each field that has a version less than or equal to the opaque's current version. That is, if the structure has a current version of 2 then only fields which have a version of 1 or 2 will be returned from this function.
Setter functions take an OmniMark MQSeries opaque and a read-only shelf. The read-only shelf must be set up to have keys which match the fields that will be set, and the corresponding values that they will be set to. Any fields which are omitted will be left unchanged. It is an error to try to set a field whose version is greater than the current version of the opaque object.
This object encapsulates the MQSeries MQCNO object. The getter for mq-connection-options is mq-get-connection-options and the setter is mq-set-connection-options.
Fields accessible in the MQSeries MQCNO structure using the
mq-connection-options getter and setter functions:
Field version Settable
StrucId 1 no
Version 1 yes
Options 1 yes
ClientConnPtr 2 yes *
* The ClientConnPtr is only indirectly settable by calling the mq-set-mqcd-of-mqcno function and gettable using the mq-get-mqcd-of-mqcno function.
This object encapsulates the MQSeries MQGMO object. The getter for mq-get-message-options is mq-get-get-message-options and the setter is mq-set-get-message-options.
Fields accessible in the MQSeries MQGMO structure using the
mq-get-message-options getter and setter functions:
Field version Settable
StrucId 1 no
Version 1 yes
Options 1 yes
WaitInterval 1 yes
Signal1 1 yes
Signal2 1 yes
ResolvedQName 1 no
MatchOptions 2 yes
GroupStatus 2 no
SegmentStatus 2 no
Segmentation 2 no
MsgToken 3 yes
ReturnedLength 3 no
This object encapsulates the MQSeries MQMD object. The getter for mq-message-descriptor is mq-get-message-descriptor and the setter is mq-set-message-descriptor.
Fields accessible in the MQSeries MQMD structure using the
mq-message-descriptor getter and setter functions:
Field version Settable
StrucId 1 no
Version 1 yes
Report 1 yes
MsgType 1 yes
Expiry 1 yes
Feedback 1 yes
Encoding 1 yes
CodedCharSetId 1 yes
Format 1 yes
Priority 1 yes
Persistence 1 yes
MsgId 1 yes
CorrelId 1 yes
BackoutCount 1 no
ReplyToQ 1 yes
ReplyToQMgr 1 yes
UserIdentifier 1 yes
AccountingToken 1 yes
ApplIdentityData 1 yes
PutApplType 1 yes
PutApplName 1 yes
PutDate 1 yes
PutTime 1 yes
ApplOriginData 1 yes
GroupId 2 yes
MsgSeqNumber 2 yes
Offset 2 yes
MsgFlags 2 yes
OriginalLength 2 yes
This object encapsulates the MQSeries MQOD object. The getter for mq-object-descriptor is mq-get-object-descriptor and the setter is mq-set-object-descriptor.
Fields accessible in the MQSeries MQOD structure using the
mq-object-descriptor getter and setter functions:
Field version Settable
StrucId 1 no
Version 1 yes
ObjectType 1 yes
ObjectName 1 yes
ObjectQMgrName 1 yes
DynamicQName 1 yes
AlternateUserId 1 yes
RecsPresent 2 no
KnownDestCount 2 no
UnknownDestCount 2 no
InvalidDestCount 2 no
ObjectRecPtr 2 yes *
ResponseRecPtr 2 no
AlternateSecurityId 3 yes
ResolvedQName 3 no
ResolvedQMgrName 3 no
* The ObjectRecPtr is settable via the mq-set-mqor-of-mqod function and gettable via the mq-get-mqor-of-mqod function Both of these functions work with shelves of mq-object-descriptor objects.
For more information about getting values from the ResponseRecPtr see the Error Handling Document.
This object encapsulates the MQSeries MQOR object. The getter for mq-object-record is mq-get-object-record and the setter is mq-set-object-record.
Fields accessible in the MQSeries MQOR structure using the
mq-object-record getter and setter functions:
Field version Settable
ObjectName 1 yes
ObjectQMgrName 1 yes
This is not a versioned structure as there is no version field.
This object encapsulates the MQSeries MQPMO object. The getter for mq-put-message-options is mq-get-put-message-options and the setter is mq-set-put-message-options.
Fields accessible in the MQSeries MQPMO structure using the
mq-put-message-options getter and setter functions:
Field version Settable
StrucId 1 no
Version 1 yes
Options 1 yes
KnownDestCount 1 no
UnknownDestCount 1 no
InvalidDestCount 1 no
ResolvedQName 1 no
ResolvedQMgrName 1 no
This object encapsulates the MQSeries MQRR object. The getter for the mq-response-record is mq-get-response-record.
Fields accessible in the MQSeries MQRR structure using the
mq-response-record getter function.
Field version Settable
CompCode 1 no
Reason 1 no
As with the mq-object-descriptor, this is not a properly versioned structure. Also note that the fields are both integer values and therefore the type of shelf passed must be an integer shelf.
This object encapsulates the MQSeries MQCD object. The getter for mq-connection-descriptor is mq-get-connection-descriptor and the setter is mq-set-connection-descriptor.
Fields accessible in the MQSeries MQCD structure using the
mq-connection-descriptor getter and setter functions:
Field version Settable
ChannelName 1 yes
Version 1 yes
ChannelType 1 yes
TransportType 1 yes
Desc 1 yes
QMgrName 1 yes
XmitQName 1 yes
ShortConnectionName 1 yes
ModeName 1 yes
TpName 1 yes
BatchSize 1 yes
DiscInterval 1 yes
ShortRetryCount 1 yes
ShortRetryInterval 1 yes
LongRetryCount 1 yes
LongRetryInterval 1 yes
SeqNumberWrap 1 yes
MaxMsgLength 1 yes
PutAuthority 1 yes
DataConversion 1 yes
UserIdentifier 2 yes
Password 2 yes
MCAUserIdentifier 2 yes
MCAType 2 yes
ConnectionName 2 yes
MsgRetryCount 3 yes
MsgRetryInterval 3 yes
HeartbeatInterval 4 yes
BatchInterval 4 yes
NonPersistentMsgSpeed 4 yes
NetworkPriority 5 yes
LongMCAUserIdPtr 6 yes
LongRemoteUserIdPtr 6 yes
MCASecurityId 6 yes
RemoteSecurityId 6 yes
