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

MQe_ClientConnectionAdminMsg.h File Reference


Functions

MQERETURN mqeClientConnectionAdminMsg_new (MQeExceptBlock *pErrStruct, MQeClientConnectionAdminMsgHndl *phMsgObj, MQeStringHndl hBridgeName, MQeStringHndl hMQQMgrProxyName, MQeStringHndl hClientConnectionName, MQEBOOL affectChildren)
 This function constructs an MQeClientConnectionAdminMsg.

MQERETURN mqeClientConnectionAdminMsg_free (MQeClientConnectionAdminMsgHndl hMsg, MQeExceptBlock *pErrStruct)
 Frees the MQeClientConnectionAdminMsgHndl pointed to by phMsgObj.

MQERETURN mqeClientConnectionAdminMsg_getClientConnectionName (MQeClientConnectionAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phClientConnectionName)
 Gets the client connection name from the administered object.

MQERETURN mqeClientConnectionAdminMsg_putClientConnectionName (MQeClientConnectionAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hClientConnectionName)
 Puts the client connection name in an MQSeries Everyplace field in the MQeFields administration message object.

MQERETURN mqeClientConnectionAdminMsg_setName (MQeClientConnectionAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl hBridgeName, MQeStringHndl hMQQMgrProxyName, MQeStringHndl hClientConnectionName)
 Puts the name information in an MQSeries Everyplace field in the MQeFields administration message object.


Detailed Description

This object is used to encapsulate an administration command. It is created by the application that is doing the administration. MQeClientConnectionAdminMsg 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.

MQe_ClientConnectionAdminMsg is a subclass of the MQeMQQMgrProxyAdminMsg so its methods and those of its superclasses can be applied to handles of MQe_ClientConnectionAdminMsg

Methods specific to this type of administration message are getClientConnectionName, putClientConnectionName, and setName.


Function Documentation

MQERETURN mqeClientConnectionAdminMsg_new MQeExceptBlock   pErrStruct,
MQeClientConnectionAdminMsgHndl *    phMsgObj,
MQeStringHndl    hBridgeName,
MQeStringHndl    hMQQMgrProxyName,
MQeStringHndl    hClientConnectionName,
MQEBOOL    affectChildren
 

The constructed object includes fields that are needed to initialize the administration message It does not include the action that the message holds.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phMsgObj  [out] Pointer to handle for output.
bridgeName  [in] MQeString containing the name of the MQSeries_bridge to which the administration message is not sent. If set to null or "", then the field is not set.
nameOfMQQMgrProxy  [in] MQeString of the name of the proxy If set to null or "", then the field is not set.
clientConnectionName  [in] MQeString. The name of the client connection. If set to null or "", then the field is not set.
affectChildren  [in] A boolean flag indicating whether or not this administration message should affect all the children. This is only applicable if the action is start or delete.
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 mqeClientConnectionAdminMsg_free MQeClientConnectionAdminMsgHndl    hMsg,
MQeExceptBlock   pErrStruct
 

Parameters:
hMsgObj  [in] MQeClientConnectionAdminMsgHndl 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 mqeClientConnectionAdminMsg_getClientConnectionName MQeClientConnectionAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phClientConnectionName
 

Can be issued against an MQeClientConnectionAdminMsg or one of its descendants (ie. MQeListenerAdminMsg).

Parameters:
hMsgObj  [in] MQeClientConnectionAdminMsgHndl
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phClientConnectionName  [out] The name of the client connection to which this administration message is to be sent to. Set using the putClientConnectionName or setName methods.
Fails if the name has not yet been set in this administration message, or if the name that has been set is invalid.
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 mqeClientConnectionAdminMsg_putClientConnectionName MQeClientConnectionAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hClientConnectionName
 

Parameters:
hMsgObj  [in] MQeClientConnectionAdminMsgHndl
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
clientConnectionName  [in] A String. The name of the client connection administered object to which this administration message is directed. This string is validated using the validateName() method to make sure that it contains only legal characters.
Fails if there are illegal characters in the client connection name parameter.
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 mqeClientConnectionAdminMsg_setName MQeClientConnectionAdminMsgHndl    hMsgObj,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hBridgeName,
MQeStringHndl    hMQQMgrProxyName,
MQeStringHndl    hClientConnectionName
 

Also sets the name of the MQSeries Everyplace queue manager that is associated with this bridge.

Parameters:
hMsgObj  [in] MQeClientConnectionAdminMsgHndl
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
bridgeName  [in] The name of the bridge to which the administration message is directed. If set to null, or "", the field is not set.
mqQMgrProxyName  [in] A String. The name of the MQSeries queue manager proxy to which the administration message is directed. If set to null, or "", the field is not set.
clientConnectionName  [in] A String. The name of the client connection to which the administration message is directed. If set to null, or "", the field is not set.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Fails if there are any invalid characters in the name parameters.
Return values:
MQERETURN_OK  Completed Successfully


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