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

MQe_ConnectionAdminMsg.h File Reference

Administration message to configure connections. More...


Functions

MQERETURN mqeConnectionAdminMsg_new (MQeExceptBlock *pErrStruct, MQeConnectionAdminMsgHndl *phMsgObj, MQeStringHndl hQueueMgr)
 Creates a new ConnectionAdminMsg.

MQERETURN mqeConnectionAdminMsg_create (MQeConnectionAdminMsgHndl hMsg, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hAdapter, MQECONST MQeStringHndl hParameters, MQECONST MQeStringHndl hOptions, MQECONST MQeStringHndl hChannel, MQeStringHndl hDescription)
 Sets up the administration message to perform the Action_Create action.

MQERETURN mqeConnectionAdminMsg_update (MQeConnectionAdminMsgHndl hMsg, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hAdapter, MQECONST MQeStringHndl hParameters, MQECONST MQeStringHndl hOptions, MQECONST MQeStringHndl hChannel, MQeStringHndl hDescription)
 Sets up the administration message to perform the Action_Update action.

MQERETURN mqeConnectionAdminMsg_free (MQeConnectionAdminMsgHndl hMsg, MQeExceptBlock *pErrStruct)
 Frees the MQeConnectionAdminMsg pointed by hMsg.


Detailed Description

Provides the ability to manage connections. The following actions are applicable on connections

Connections define how one queue manager establishes a connection to another queue manager. The main characteristics associated with a connection are:

Type of Channel to use:

File Descriptor containing communications adapter and parameters: A file descriptor for an http connection to server 192.168.0.1 on port 8082 would be specified as com.ibm.mqe.Adapters.MQeTcpipHttpAdapter:192.168.0.1:8082 or, if an alias of "Network" has been setup (recommended) for the HTTP adapter, the following file descriptor could be used Network:192.168.0.1:8082


Function Documentation

MQERETURN mqeConnectionAdminMsg_new MQeExceptBlock   pErrStruct,
MQeConnectionAdminMsgHndl *    phMsgObj,
MQeStringHndl    hQueueMgr
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phMsgObj  [in/out] Pointer to handle for output
pQueueMgr  [in] String containing queue manager name must be NULL if pData specified
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
pData and pQueueMgr are exclusive, that is one or neither can be specified, but not both.
Returns :
A new MQeConnectionAdminMsg handle in (*phMsgObj) MQERETURN_* and output in (*phMsgObj)
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeConnectionAdminMsg_create MQeConnectionAdminMsgHndl    hMsg,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hAdapter,
MQECONST MQeStringHndl    hParameters,
MQECONST MQeStringHndl    hOptions,
MQECONST MQeStringHndl    hChannel,
MQeStringHndl    hDescription
 

Sets up the administration message to perform the MQE_ADMIN_ACTION_CREATE action This version of mqeConnectionAdminMsg_create adds a simple connection definition for a connection that has one adapter.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
hMsg  [in] ConnectionAdminMsg handle.
pAdapter  [in] File descriptor for the adapter, for example: "Network:127.0.0.1:8081"
pParameters  [in] Adapter parameters, for example. "/servlet/MQe"
pOptions  [in] Adapter options.
pChannel  [in] Type of channel to use
hDescription  [in] Description
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 mqeConnectionAdminMsg_update MQeConnectionAdminMsgHndl    hMsg,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hAdapter,
MQECONST MQeStringHndl    hParameters,
MQECONST MQeStringHndl    hOptions,
MQECONST MQeStringHndl    hChannel,
MQeStringHndl    hDescription
 

Sets up the administration message to perform the MQE_ADMIN_ACTION_UPDATE action. This version of mqeConnectionAdminMsg_update replaces an existing connection definition for a connection that has one adapter.

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
hMsg  [in] ConnectionAdminMsg handle.
pAdapter  [in] File descriptor for the adapter, for example: "Network:127.0.0.1:8081"
pParameters  [in] Adapter parameters, for example. "/servlet/MQe"
pOptions  [in] Adapter options.
pChannel  [in] Type of channel to use
hDescription  [in] Description
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 mqeConnectionAdminMsg_free MQeConnectionAdminMsgHndl    hMsg,
MQeExceptBlock   pErrStruct
 

Parameters:
hMsg  [in] the MQeConnectionAdminMsg to be freed.
pErrStruct  [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:18 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference