com.ibm.mq
Class MQGetMessageOptions

java.lang.Object
  |
  +--com.ibm.mq.MQGetMessageOptions

public class MQGetMessageOptions
extends java.lang.Object

This class contains options which control the behaviour of MQQueue.get().


Field Summary
 char groupStatus
          Whether the retrieved message is in a group, and if it is, whether it is the last in the group.
 int matchOptions
          Selection criteria that determine which message is retrieved.
 byte[] msgToken
          A token for use when getting messages.
 int options
          Options that control the action of MQQueue.get().
 java.lang.String resolvedQueueName
          The local name of the queue from which the message was retrieved.
 int returnedLength
          The length in bytes of the message data.
 char segmentation
          Whether segmentation is allowed for the retrieved message.
 char segmentStatus
          Whether the retrieved message is a segment of a logical message.
 int waitInterval
          The maximum time (in milliseconds) that an MQQueue.get() call waits for a suitable message to arrive.
 
Constructor Summary
MQGetMessageOptions()
          Constructs an MQGetMessageOptions object with options set to MQC.MQGMO_MO_WAIT, a wait interval of zero, and a blank resolved queue name.
MQGetMessageOptions(boolean noReadBack)
          Constructs an MQGetMessageOptions object with an option on reading options field.
 
Method Summary
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

options

public int options
Options that control the action of MQQueue.get(). Any or none of the following values can be specified. If more than one option is required the values can combined using either '+' or '|'.


waitInterval

public int waitInterval
The maximum time (in milliseconds) that an MQQueue.get() call waits for a suitable message to arrive. It is used in conjunction with MQC.MQGMO_WAIT. A value of MQC.MQWI_UNLIMITED indicates that an unlimited wait is required.


resolvedQueueName

public java.lang.String resolvedQueueName
The local name of the queue from which the message was retrieved. This is the resolved name as set by the queue manager. It is different from the name used to open the queue, if an alias queue or model queue was opened.


msgToken

public byte[] msgToken
A token for use when getting messages. It is set either by the queue manager or by the application in combination with MQMO_MATCH_MSG_TOKEN. The token is truncated if its size is greater than MQC.MQ_MSG_TOKEN_LENGTH. It is ignored if it has been set without the corresponding matchOption being set. If matchOption is set for a platform other than z/OS an attempted get will fail.


returnedLength

public int returnedLength
The length in bytes of the message data. It is set by the queue manager to the value returned by the MQGET call. If the queue manager does not support this capability, the value is set to MQC.MQRL_UNDEFINED.


matchOptions

public int matchOptions
Selection criteria that determine which message is retrieved. The following match options can be set: The default value is MQC.MQMO_MATCH_MSG_ID | MQC.MQMO_MATCH_CORREL_ID.


groupStatus

public char groupStatus
Whether the retrieved message is in a group, and if it is, whether it is the last in the group. Possible values are:


segmentStatus

public char segmentStatus
Whether the retrieved message is a segment of a logical message. If the message is a segment, this field also indicates whether or not it is the last segment. Possible values are:


segmentation

public char segmentation
Whether segmentation is allowed for the retrieved message. Possible values are:

Constructor Detail

MQGetMessageOptions

public MQGetMessageOptions()
Constructs an MQGetMessageOptions object with options set to MQC.MQGMO_MO_WAIT, a wait interval of zero, and a blank resolved queue name.


MQGetMessageOptions

public MQGetMessageOptions(boolean noReadBack)
Constructs an MQGetMessageOptions object with an option on reading options field. You can use this constructor to save some overheads if your application never needs to read back the options field.

Parameters:
noReadBack - if true, prevents the options MQGMO field from being read back. This means that the overhead of converting it is avoided.

(c) Copyright IBM Corp. 2005. All Rights Reserved.