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

MQe_Session.h File Reference

The WebSphere MQ Everyplace Session class API header file. More...


Enumerations

enum  MQELOGTYPE
 WebSphere MQSeries Everyplace log type constants. More...

enum  MQELOGNUMBER
 WebSphere MQSeries Everyplace log number values. More...


Functions

MQERETURN mqeSession_initialize (MQeExceptBlock *pErrStruct)
 This function initializes a WebSphere MQ Everyplace session.

MQERETURN mqeSession_terminate (MQeExceptBlock *pErrStruct)
 This function terminates a WebSphere MQ Everyplace session.

MQERETURN mqeSession_threadAttach (MQeExceptBlock *pErrStruct)
 This function attaches the running thread to a JVM.

MQERETURN mqeSession_threadDetach (MQeExceptBlock *pErrStruct)
 This function detaches the running thread from the JVM it is currently attached to.


Detailed Description

This file describes MQeSession API prototypes.

Every application needs to start one (and only one) WebSphere MQ Everyplace session in order to access WebSphere MQ Everyplace functionality.


Enumeration Type Documentation

enum MQELOGTYPE
 

Warning:
Do not insert new entries between already defined entries other than just before the last one unless the original ones are already assigned specific values. Otherwise, the original value definitions might be broken.

enum MQELOGNUMBER
 

Warning:
Do not insert new entries between already defined entries other than just before the last one unless the original ones are already assigned specific values. Otherwise, the original value definitions might be broken.


Function Documentation

MQERETURN mqeSession_initialize MQeExceptBlock   pErrStruct
 

Parameters:
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_ALLOCATION_FAIL 
  • Not enough heap space
Warning:
Users are expected to call mqeSession_terminate() after completing all WebSphere MQ Everyplace operations.

MQERETURN mqeSession_terminate MQeExceptBlock   pErrStruct
 

Parameters:
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  Operation successful

MQERETURN mqeSession_threadAttach MQeExceptBlock   pErrStruct
 

Parameters:
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  Operation successful
Note:
This is for the Java bindings version only.
Warning:
Users are expected to use mqeSession_threadDetach() to detach the thread when it is no longer needed.

MQERETURN mqeSession_threadDetach MQeExceptBlock   pErrStruct
 

Parameters:
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  Operation successful
Note:
This is for the Java bindings version only.


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