Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

MQe_MQBridgeQueueAdminMsg.h File Reference


Functions

MQERETURN mqeMQBridgeQueueAdminMsg_new (MQeExceptBlock *pErrStruct, MQeMQBridgeQueueAdminMsgHndl *phMsgObj, MQeStringHndl hBridgeName, MQeStringHndl hMQQMgrProxy, MQeStringHndl hClientConnectionName, MQEINT32 maxIdleTimeout)
MQERETURN mqeMQBridgeQueueAdminMsg_free (MQeStringHndl hClientConnectionName, MQeExceptBlock *pErrStruct)
 Frees the MQeMQBridgeQueueAdminMsgHndl pointed by phMsgObj.


Detailed Description


Function Documentation

MQERETURN mqeMQBridgeQueueAdminMsg_new MQeExceptBlock   pErrStruct,
MQeMQBridgeQueueAdminMsgHndl *    phMsgObj,
MQeStringHndl    hBridgeName,
MQeStringHndl    hMQQMgrProxy,
MQeStringHndl    hClientConnectionName,
MQEINT32    maxIdleTimeout
 

Create the administration message to administer the bridge queue. Specify some initial values for some of the attributes.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phMsgObj  [out] Pointer to handle for output
bridgeName  [in] The name of the bridge to which the client connection belongs
mqQMgrProxyName  [in] The name of the MQSeries queue manager to which the queue issues messages.
clientConnectionName  [in] The name of the bridge client connection object that is used to communicate with the MQSeries queue manager.
maxIdleTimeout  [in] The number of minutes the queue is allowed to hold a connection to the MQSeries system without using it. When the queue has been unused for this duration, the connection is returned to the connection pool. If 0, the connection is returned to the connection pool immediately it has been used. ie: After the put of every message.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully
Warning:
Users are expected to use mqeBridgeQueueAdminMsg_free() to free the object returned by this call when it is no longer needed. This enables reuse of system resources and can help to avoid system problems caused by shortage of resources.

MQERETURN mqeMQBridgeQueueAdminMsg_free MQeStringHndl    hClientConnectionName,
MQeExceptBlock   pErrStruct
 

Parameters:
hMsgObj  [in] MQeListenerAdminMsgHndl to be freed
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully


Generated Thu Aug 11 23:41:19 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference