QAManagerBase class

This class acts as a base class for QATransactionalManager and QAManager, which manage transactional and non-transactional messaging, respectively.

Syntax

public class QAManagerBase

Members

All members of QAManagerBase class, including all inherited members.

Name	Description
beginEnumStorePropertyNames method	Begins an enumeration of message store property names.
browseClose method	Frees the resources associated with a browse operation.
browseMessages method	Begins a browse of messages queued in the message store.
browseMessagesByID method	Begins a browse of the message that is queued in the message store, with the given message ID.
browseMessagesByQueue method	Begins a browse of messages queued in the message store for the given queue.
browseMessagesBySelector method	Begins a browse of messages queued in the message store that satisfy the given selector.
browseNextMessage method	Returns the next message for the given browse operation, returning null if there are no more messages.
cancelMessage method	Cancels the message with the given message ID.
close method	Closes the connection to the QAnywhere message system and releases any resources used by the QAManagerBase.
createBinaryMessage method	Creates a QABinaryMessage instance.
createTextMessage method	Creates a QATextMessage instance.
deleteMessage method	Deletes a QAMessage object.
endEnumStorePropertyNames method	Frees the resources associated with a message store property name enumeration.
getAllQueueDepth method	Returns the total depth of all queues, based on a given filter.
getBooleanStoreProperty method	Gets a boolean value for a predefined or custom message store property.
getByteStoreProperty method	Gets a byte value for a predefined or custom message store property.
getDoubleStoreProperty method	Gets a double value for a predefined or custom message store property.
getFloatStoreProperty method	Gets a float value for a predefined or custom message store property.
getIntStoreProperty method	Gets an int value for a predefined or custom message store property.
getLastError method	The error code associated with the last executed QAManagerBase method.
getLastErrorMsg method	The error text associated with the last executed QAManagerBase method.
getLastNativeError method	The native error code associated with the last executed QAManagerBase method.
getLongStoreProperty method	Gets a long value for a predefined or custom message store property.
getMessage method	Returns the next available QAMessage sent to the specified address.
getMessageBySelector method	Returns the next available QAMessage sent to the specified address that satisfies the given selector.
getMessageBySelectorNoWait method	Returns the next available QAMessage sent to the given address that satisfies the given selector.
getMessageBySelectorTimeout method	Returns the next available QAMessage sent to the given address that satisfies the given selector.
getMessageNoWait method	Returns the next available QAMessage sent to the given address.
getMessageTimeout method	Returns the next available QAMessage sent to the given address.
getMode method	Returns the QAManager acknowledgement mode for received messages.
getQueueDepth method	Returns the depth of a queue, based on a given filter.
getShortStoreProperty method	Gets a short value for a predefined or custom message store property.
getStringStoreProperty method	Gets a string value for a predefined or custom message store property.
nextStorePropertyName method	Returns the message store property name for the given enumeration.
putMessage method	Puts a message into the queue for the given destination.
putMessageTimeToLive method	Puts a message into the queue for the given destination and a given time-to-live in milliseconds.
setBooleanStoreProperty method	Sets a predefined or custom message store property to a boolean value.
setByteStoreProperty method	Sets a predefined or custom message store property to a byte value.
setDoubleStoreProperty method	Sets a predefined or custom message store property to a double value.
setFloatStoreProperty method	Sets a predefined or custom message store property to a float value.
setIntStoreProperty method	Sets a predefined or custom message store property to an int value.
setLongStoreProperty method	Sets a predefined or custom message store property to a long value.
setMessageListener method	Sets a message listener class to receive QAnywhere messages asynchronously.
setMessageListenerBySelector method	Sets a message listener class to receive QAnywhere messages asynchronously, with a message selector.
setProperty method	Allows you to set QAnywhere manager configuration properties programmatically.
setShortStoreProperty method	Sets a predefined or custom message store property to a short value.
setStringStoreProperty method	Sets a predefined or custom message store property to a string value.
start method	Starts the QAManagerBase for receiving incoming messages in message listeners.
stop method	Stops the QAManagerBase's reception of incoming messages.
triggerSendReceive method	Causes a synchronization with the QAnywhere message server, uploading any messages addressed to other clients, and downloading any messages addressed to the local client.

Remarks

Use the QAManagerBase::start() method to allow a QAManagerBase instance to listen for messages. There must be only a single instance of QAManagerBase per thread in your application.

You can use instances of this class to create and manage QAnywhere messages. Use the QAManagerBase::createBinaryMessage() method and the QAManagerBase::createTextMessage() method to create appropriate QAMessage instances. QAMessage instances provide a variety of methods to set message content and properties. To send QAnywhere messages, use the QAManager::putMessage() to place the addressed message in the local message store queue. The message is transmitted by the QAnywhere Agent based on its transmission policies or when you call the QAManagerBase::triggerSendReceive().

For more information about qaagent transmission policies, see Determining when message transmission should occur on the client.

Messages are released from memory when you close a QAManagerBase instance using the QAManagerBase::close().

You can use QAManagerBase::getLastError, QAManagerBase::getLastNativeError, and QAManagerBase::getLastErrorMessage to return error information when a QAException occurs. QAManagerBase also provides methods to set and get message store properties.

For more information, see Client message store properties and the MessageStoreProperties.