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

MQe_ChnlListener.h File Reference

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


Functions

MQERETURN mqeChannelListener_new (MQeExceptBlock *pErrStruct, MQeChannelListenerHndl *phListener, MQeStringHndl hFileDesc, MQeStringHndl hFileType, MQeChannelManagerHndl hChannelManager)
 This function creates a new MQeChannelListener object.

MQERETURN mqeChannelListener_activate (MQeChannelListenerHndl hListener, MQeExceptBlock *pErrStruct, MQeStringHndl hFileDesc, MQeStringHndl hFileType, MQeChannelManagerHndl hChannelManager)
 This function activates hListener.

MQERETURN mqeChannelListener_setTimer (MQeChannelListenerHndl hListener, MQeExceptBlock *pErrStruct, MQEINT32 interval)
 This function sets a channel time-out interval for any channels accepted by hListener.

MQERETURN mqeChannelListener_stop (MQeChannelListenerHndl hListener, MQeExceptBlock *pErrStruct)
 This function stops hListener accepting any new channel requests.

MQERETURN mqeChannelListener_free (MQeChannelListenerHndl hListener, MQeExceptBlock *pErrStruct)
 This function frees the hListener MQeChannelListener object.


Detailed Description

Describes MQeChannelListener C API prototypes.

Notes


Function Documentation

MQERETURN mqeChannelListener_new MQeExceptBlock   pErrStruct,
MQeChannelListenerHndl *    phListener,
MQeStringHndl    hFileDesc,
MQeStringHndl    hFileType,
MQeChannelManagerHndl    hChannelManager
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phListener  [out] Pointer for output channel listener
hFileDesc  [in] File descriptor string used to listen for incoming requests
hFileType  [in] String defining hFileDesc
hChannelManager  [in] Channel manager to be used
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null)
Returns :
(*phListener).
Return values:
MQERETURN_OK 
  • MQEREASON_OK Operation successful
  • MQEREASON_SESSION_ALREADY_INITIALIZED Session already initialized
MQERETURN_ALLOCATION_FAIL  Not enough heap space
Note:
This function calls mqeChannelListener_activate internally if hFileDesc and hFileType are not NULL.
Warning:
mqeChannelListener_free() should be called to free (*phListener) when it is no longer needed.

MQERETURN mqeChannelListener_activate MQeChannelListenerHndl    hListener,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hFileDesc,
MQeStringHndl    hFileType,
MQeChannelManagerHndl    hChannelManager
 

Parameters:
hListener  [in] Channel listener to be activated
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFileDesc  [in] File descriptor string used to listen for incoming requests
hFileType  [in] String defining hFileDesc
hChannelManager  [in] Channel manager to be used
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_ALLOCATION_FAIL  Not enough heap space

MQERETURN mqeChannelListener_setTimer MQeChannelListenerHndl    hListener,
MQeExceptBlock   pErrStruct,
MQEINT32    interval
 

Parameters:
hListener  [in] Channel listener to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
interval  [in] New time-out interval.
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 mqeChannelListener_stop MQeChannelListenerHndl    hListener,
MQeExceptBlock   pErrStruct
 

Parameters:
hListener  [in] Channel listener to be operated on
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

MQERETURN mqeChannelListener_free MQeChannelListenerHndl    hListener,
MQeExceptBlock   pErrStruct
 

Parameters:
hListener  [in] Channel listener 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