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

MQe_Queue.h File Reference


Detailed Description

Parameter structures for MQeQueue.

When queues are created a number of parameters are required. These are passed in in structures which are documented here. All structures have default values that can be set using a number of initialization macros. For most situations these default values should be sufficient. These default values also indicate those parameters that are mandatory.

There is a base structure MQeQueueParms which is used to fill out information that is common to all queues.

For other types of queues, MQeRemoteSyncQParms for example, the queue parameter structure contains MQeQueueParms, plus additional fields specifically required for the type of queue (for example, for a RemoteSyncQueue).

Note that some of the items in the structures are intended for use only in the inquire functions.


Data Structures

struct  MQeQueueParms
 Configuration Structure for processing a Queue. More...

struct  MQeRemoteSyncQParms
 Configuration Structure for processing a Remote Sync Queue. More...

struct  MQeRemoteAsyncQParms
 Configuration Structure for processing a Remote Async queue. More...

struct  MQeAdminQParms
 Configuration Structure for processing an Admin Queue. More...

struct  MQeHomeServerQParms
 Configuration Structure for processing a home server Queue. More...

struct  MQeStoreAndForwardQParms
 Configuration Structure for processing a Store and Forward Queue. More...


Defines

#define QUEUE_INIT_VAL
 initial value for the Queue parameter structure

#define QUEUE_DESC_OP
 bit flag for the structure description field

#define QUEUE_FILE_DESC_OP
 bit flag for the structure file description field

#define QUEUE_ALIAS_NAMES_OP
 bit flag for the structure queue alias name list field

#define QUEUE_EXPIRY_OP
 bit flag for the structure queue expiry field

#define QUEUE_CREATION_DATE_OP
 bit flag for the structure queue creation date field

#define QUEUE_MAX_MSG_SIZE_OP
 bit flag for the structure queue maximum message size field

#define QUEUE_MAX_Q_SIZE_OP
 bit flag for the structure queue maximum queue size field

#define QUEUE_CURRENT_SIZE_OP
 bit flag for the structure queue current size field

#define QUEUE_ACTIVE_OP
 bit flag for the structure queue active field

#define QUEUE_TARGET_REG_OP
 bit flag for the structure queue target registry field

#define QUEUE_MODE_OP
 bit flag for the structure queue mode field

#define QUEUE_PRIORITY_OP
 bit flag for the structure queue priority field

#define QUEUE_NAME_NOT_REQUIRED_OP
 bit flag for the structure queue name field (queue name will not be set)

#define QUEUE_ALL_OP
 mask for all bit flags for the structure

#define LOCAL_Q_ALL_OP
 mask for all bit flags for the structure

#define LOCAL_Q_INIT_VAL
 initial value for the Local Queue parameter structure

#define SET_LOCAL_Q_INIT_VAL(localQParms)
 initial value for the Local Queue parameter structure

#define REMOTE_SYNC_Q_INIT_VAL
 initial value for the Remote Sync Queue parameter structure

#define SET_REMOTE_SYNC_Q_INIT_VAL(remoteSyncQParms)
 initial value for the Remote Sync Queue parameter structure

#define REMOTE_SYNC_Q_TRANS_OP
 bit flag for the remote Sync queue structure transporter field

#define REMOTE_SYNC_Q_ALL_OP
 mask for all bit flags for the structure

#define REMOTE_ASYNC_Q_INIT_VAL
 initial value for the Remote Async Queue parameter structure

#define SET_REMOTE_ASYNC_Q_INIT_VAL(remoteAsyncQParms)
 initial value for the Remote Async Queue parameter structure

#define REMOTE_ASYNC_Q_TRANS_OP
 bit flag for the remote Async queue structure transporter field

#define REMOTE_ASYNC_Q_ALL_OP
 mask for all bit flags for the structure

#define ADMIN_Q_INIT_VAL
 initial value for the Admin Queue parameter structure

#define SET_ADMIN_Q_INIT_VAL(adminQParms)
 initial value for the Admin Queue parameter structure

#define ADMIN_Q_INTERVAL_OP
 bit flag for the remote queue structure timer interval field

#define ADMIN_Q_ALL_OP
 mask for all bit flags for the structure

#define HOME_SERVER_Q_INIT_VAL
 initial value for the Home Server Queue parameter structure

#define SET_HOME_SERVER_Q_INIT_VAL(hsQParms)
 initial value for the Home Server Queue parameter structure

#define HOME_SERVER_Q_INTERVAL_OP
 bit flag for the home server queue structure timer interval field

#define HOME_SERVER_Q_ALL_OP
 mask for all bit flags for the structure

#define STORE_AND_FORWARD_Q_INIT_VAL
 initial value for the Store and Forward Queue parameter structure

#define SET_STORE_AND_FORWARD_Q_INIT_VAL(safQParms)
 initial value for the Store and Forward Queue parameter structure

#define STORE_AND_FORWARD_Q_ALL_OP
 mask for all bit flags for the structure


Typedefs

typedef MQeQueueParms MQeQueueParms
 Configuration Structure for processing a Queue.

typedef MQeQueueParms MQeLocalQParms
 Configuration Structure for processing a Local Queue.

typedef MQeRemoteSyncQParms MQeRemoteSyncQParms
 Configuration Structure for processing a Remote Sync Queue.

typedef MQeRemoteAsyncQParms MQeRemoteAsyncQParms
 Configuration Structure for processing a Remote Async queue.

typedef MQeAdminQParms MQeAdminQParms
 Configuration Structure for processing an Admin Queue.

typedef MQeHomeServerQParms MQeHomeServerQParms
 Configuration Structure for processing a home server Queue.

typedef MQeStoreAndForwardQParms MQeStoreAndForwardQParms
 Configuration Structure for processing a Store and Forward Queue.


Typedef Documentation

typedef struct MQeQueueParms MQeQueueParms
 

Configuration Structure for processing a Queue.

A structure which contains the information that is required to administer a Queue. These are the features which are common to all queues.

The same structure is used to creation/inquire/update. Some elements are not permitted for some operations.

typedef struct MQeQueueParms MQeLocalQParms
 

Configuration Structure for processing a Local Queue.

A structure which contains the information that is required to administer a Local Queue.

typedef struct MQeRemoteSyncQParms MQeRemoteSyncQParms
 

Configuration Structure for processing a Remote Sync Queue.

A structure which contains the information that is required to administer a Remote Sync Queue.

typedef struct MQeRemoteAsyncQParms MQeRemoteAsyncQParms
 

Configuration Structure for processing a Remote Async queue.

A structure which contains the information that is required to administer a Remote Async Queue.

typedef struct MQeAdminQParms MQeAdminQParms
 

Configuration Structure for processing an Admin Queue.

A structure which contains the information that is required to administer an Admin Queue.

typedef struct MQeHomeServerQParms MQeHomeServerQParms
 

Configuration Structure for processing a home server Queue.

A structure which contains the information that is required to administer a home server Queue.

typedef struct MQeStoreAndForwardQParms MQeStoreAndForwardQParms
 

Configuration Structure for processing a Store and Forward Queue.

Note:
Store and Forward Queues are not currently supported in this release of the C Codebase


Generated Thu Aug 11 23:27:11 2005 for Websphere MQ Everyplace for Multiplatforms C Programming Reference