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

MQe_ChnlManager.h File Reference

The MQSeries Everyplace Channel Manager class C API header file. More...


Functions

MQERETURN mqeChannelManager_new (MQeExceptBlock *pErrStruct, MQeChannelManagerHndl *phManager)
 This function creates a new MQeChannelManager object.

MQERETURN mqeChannelManager_getGlobalHashtable (MQeChannelManagerHndl hManager, MQeExceptBlock *pErrStruct, MQeHashtableHndl *phTable)
 This function returns the global hash table that belongs to the channel manager. The operations on the returned table are not supported. The return table can be passed to another API call for processing.

MQERETURN mqeChannelManager_numberOfChannels (MQeChannelManagerHndl hManager, MQeExceptBlock *pErrStruct, MQEINT32 *pNoOfChannels, MQEINT32 newLimit)
 This function returns the current number of active channels and sets a new maximum number of concurrent channels newLimit (0 means no limit).

MQERETURN mqeChannelManager_timeOut (MQeChannelManagerHndl hManager, MQeExceptBlock *pErrStruct, MQEINT64 age)
 This function checks all channels to see if they have been idle for more than age milliseconds. Any channels that have exceeded this time are closed.

MQERETURN mqeChannelManager_totalNumberOfChannels (MQeChannelManagerHndl hManager, MQeExceptBlock *pErrStruct, MQEINT64 *pCount)
 This function returns the total number of channels that have been used since the channel manager was activated.

MQERETURN mqeChannelManager_free (MQeChannelManagerHndl hManager, MQeExceptBlock *pErrStruct)
 This function frees the hManager MQeChannelManager object.


Detailed Description

This page describes MQeChannelManager C API prototypes.

Divergences from Java code base:


Function Documentation

MQERETURN mqeChannelManager_new MQeExceptBlock   pErrStruct,
MQeChannelManagerHndl *    phManager
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phManager  [out] Pointer for output channel manager.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
(*phManager).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
  • MQEREASON_SESSION_ALREADY_INITIALIZED Session already initialized
MQERETURN_ALLOCATION_FAIL  Not enough heap space
Warning:
mqeChannelManager_free() should be called to free (*phManager) when it is no longer needed.

MQERETURN mqeChannelManager_getGlobalHashtable MQeChannelManagerHndl    hManager,
MQeExceptBlock   pErrStruct,
MQeHashtableHndl *    phTable
 

Parameters:
hManager  [in] Channel listener to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phTable  [out] Pointer to anoutput variable.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
  • MQEREASON_SESSION_ALREADY_INITIALIZED Session already initialized

MQERETURN mqeChannelManager_numberOfChannels MQeChannelManagerHndl    hManager,
MQeExceptBlock   pErrStruct,
MQEINT32 *    pNoOfChannels,
MQEINT32    newLimit
 

Parameters:
hManager  [in] Channel listener to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pNoOfChannels  [out] Pointer to an output variable.
newLimit  [in] New limit value.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
  • MQEREASON_SESSION_ALREADY_INITIALIZED Session already initialized

MQERETURN mqeChannelManager_timeOut MQeChannelManagerHndl    hManager,
MQeExceptBlock   pErrStruct,
MQEINT64    age
 

Parameters:
hManager  [in] Channel listener to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
age  [in] Time out value.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
  • MQEREASON_SESSION_ALREADY_INITIALIZED Session already initialized

MQERETURN mqeChannelManager_totalNumberOfChannels MQeChannelManagerHndl    hManager,
MQeExceptBlock   pErrStruct,
MQEINT64 *    pCount
 

Parameters:
hManager  [in] Channel listener to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pCount  [out] Pointer to output variable.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
  • MQEREASON_SESSION_ALREADY_INITIALIZED Session already initialized

MQERETURN mqeChannelManager_free MQeChannelManagerHndl    hManager,
MQeExceptBlock   pErrStruct
 

Parameters:
hManager  [in] The channel manager 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 
  • MQEREASON_OK Operation successful
  • MQEREASON_SESSION_ALREADY_INITIALIZED Session already initialized


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