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

MQe_ListenerAdminMsg.h File Reference


Functions

MQERETURN mqeListenerAdminMsg_new (MQeExceptBlock *pErrStruct, MQeListenerAdminMsgHndl *phMsgObj, MQeStringHndl hBridgeName, MQeStringHndl hMQQMgrProxyName, MQeStringHndl hClientConnectionName, MQeStringHndl hListener, MQEBOOL affectChildren)
MQERETURN mqeListenerAdminMsg_free (MQeListenerAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct)
 Frees the MQeListenernAdminMsgHndl pointed by phMsgObj.

MQERETURN mqeListenerAdminMsg_getListenerName (MQeListenerAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phListenerName)
MQERETURN mqeListenerAdminMsg_putListenerName (MQeListenerAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hListenerName)
MQERETURN mqeListenerAdminMsg_setName (MQeListenerAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hBridgeName, MQeStringHndl hMQQMgrProxyName, MQeStringHndl hClientConnectionName, MQeStringHndl hListenerName)

Detailed Description

Purpose : Used to encapsulate an administration command. Created by the application doing the administration. It is a special type of MQSeries Everyplace message, with helper functions for the user. The logic performed on the target MQSeries Everyplace system is also in this class. The administration queue invokes the performAction method.


Function Documentation

MQERETURN mqeListenerAdminMsg_new MQeExceptBlock   pErrStruct,
MQeListenerAdminMsgHndl *    phMsgObj,
MQeStringHndl    hBridgeName,
MQeStringHndl    hMQQMgrProxyName,
MQeStringHndl    hClientConnectionName,
MQeStringHndl    hListener,
MQEBOOL    affectChildren
 

Constructor where the MQSeries Everyplace queue manager name, the name of the bridge, the name of the proxy, the name of the client connection, and the name of the listener are passed.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phMsgObj  [out] Pointer to handle for output
bridge  [in] A String. The name of the bridge to which this administration message is to be sent. If null, or "", it is not set in the administration message.
mqQMgrProxy  [in] A String. The name of the MQSeries queue manager that owns the transmission queue the listener is set up to read from. If null, or "", it is not set in the administration message.
clientConnection  [in] A String. The name of the MQSeries client connection that is use to talk to the MQSeries queue manager. If null, or "", it is not set in the administration message.
listener  [in] A String. The name of the listener. This matches the name of the transmission queue on MQSeries to which the listener "listens", waiting for messages to be ready to move to the MQSeries Everyplace network. If null, or "", it is not set in the administration message.
affectChildren  [in] A boolean. This is used to indicate whether this administration message affects the children of the listener. There are currently no child objects to a listener, so this parameter is here for consistency with other MQSeries-bridge administration classes. The value is ignored.
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 mqeListenerAdminMsg_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 mqeListenerAdminMsg_free MQeListenerAdminMsgHndl    hMsgObj,
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

MQERETURN mqeListenerAdminMsg_getListenerName MQeListenerAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phListenerName
 

Gets the name from the administration object. Can be issued only against an MQeListenerAdminMsg.

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

MQERETURN mqeListenerAdminMsg_putListenerName MQeListenerAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hListenerName
 

Used to add the MQSeries queue manager name to the administration message. Puts the listener name in a field in the MQeFields administration message object.

Matches the name of the transmission queue on MQSeries to which the listener "listens".

Parameters:
hMsgObj  [in] MQeListenerAdminMsgHndl in question
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hListenerName  [in] String with the name of the listener
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeListenerAdminMsg_setName MQeListenerAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hBridgeName,
MQeStringHndl    hMQQMgrProxyName,
MQeStringHndl    hClientConnectionName,
MQeStringHndl    hListenerName
 

Puts the name information in a field in the MQeFields administration message object and also sets the name of the MQSeries Everplace queue manager that is associated with this MQSeries-bridge.

Parameters:
hMsgObj  [in] MQeListenerAdminMsgHndl in question
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hBridgeName  [in] Name of the MQSeries-bridge to which the administration message is directed.
hMQQMgrProxyName  [in] Name of the MQSeries queue manager that owns the transmission queue that the listener is set to read from
hClientConnectionName  [in] Name of the the client connection used to talk to the MQSeries queue manager
hListenerName  [in] Name of the listener. Matches the name of the transmission queue on MQSeries.
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