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

MQe_Queue_Constants.h File Reference


Detailed Description

API header file for the MQeQueue Constants.


Defines

#define MQE_QUEUE_MANAGER_SECTION
 Name for Queue manager section in the MQeFields used when starting queue manager.

#define MQE_REGISTRY_SECTION
 Name for Registry Section in the MQeFields used when starting queue manager.

#define MQE_QUEUE_MANAGER_NAME
 Field name for Queue manager Name.

#define MQE_QMGR_DESCRIPTION
 Description (unicode).

#define MQE_QMGR_RULES
 Rules (ascii).

#define MQE_QMGR_CHNLTIMEOUT
 Channel timeout (long).

#define MQE_QMGR_CHNLATTRRULES
 Channel attribute rules.

#define MQE_QMGR_QUEUESTORE
 Default queue store.

#define MQE_QMGR_QUEUES
 Queues known by queue manager ( fields array - Read Only ).

#define MQE_QMGR_QUEUENAME
 Queue Name.

#define MQE_QMGR_QUEUEQMGRNAME
 Queue QueueManager Name.

#define MQE_QMGR_QUEUETYPE
 Queue Type.

#define MQE_QMGR_CONNECTIONS
 Connections known by queue manager ( ascii array - Read only).

#define MQE_QMGR_BRIDGE_CAPABLE
 MQEBOOL indicating whether a QMgr is bridge capable.

#define MQE_QUEUE_QTIMERINTERVAL
 Process outstanding admin messages after interval (milliseconds) (long).

#define MQE_QMGR_ALIASES
 Queue manager aliases (ascii array).

#define MQE_QMGR_VERSION
 Queue manager version (MQEINT32 array).

#define MQE_QUEUE_QMGRNAME
 Queue manager that owns the queue (ascii).

#define MQE_QUEUE_ACTIVE
 Queue active ? (boolean, Read Only).

#define MQE_QUEUE_DESCRIPTION
 Description (unicode).

#define MQE_QUEUE_FILEDESC
 File descriptor - location where queue is stored (ascii).

#define MQE_QUEUE_CRYPTOR
 Queue security characteristics.

#define MQE_QUEUE_AUTHENTICATOR
 Queue Authenticator.

#define MQE_QUEUE_COMPRESSOR
 Queue Compressor.

#define MQE_QUEUE_TARGETREGISTRY
 Queue Target Registry.

#define MQE_QUEUE_MAXMSGSIZE
 Maximum length of messages allowed on the queue (int).

#define MQE_QUEUE_PRIORITY
 Default priority for messages if not already specified in the message (byte).

#define MQE_QUEUE_MODE
 Type of queue (byte).

#define MQE_QUEUE_LOCAL
 Local Queue.

#define MQE_QUEUE_REMOTE
 Remote Queue.

#define MQE_QUEUE_HOME_SERVER
 HomeServer Queue.

#define MQE_QUEUE_ADMIN
 Admin Queue.

#define MQE_QUEUE_ASYNCHRONOUS
 Asynchronous Queue.

#define MQE_QUEUE_SYNCHRONOUS
 Synchronous Queue.

#define MQE_QUEUE_EXPIRY
 Messages on queue expire n milliseconds after being stored on the queue (long).

#define MQE_QUEUE_MAXQSIZE
 Maximum number of messages allowed on the queue (int).

#define MQE_QUEUE_NOLIMIT
 Value for no limit.

#define MQE_QUEUE_CURRENTSIZE
 Current queue depth (int, Read Only).

#define MQE_QUEUE_QALIASNAMELIST
 Set of alias names for this queue (ascii array).

#define MQE_QUEUE_QMGRNAMELIST
 List of queue manager targets handled by this store&forward queue (AsciiArray).

#define MQE_QUEUE_TRANSPORTER
 Name of the transporter class to use (ascii).

#define MQE_QUEUE_DEFAULTTRANSPORTER
 Queue Default Transporter.


Define Documentation

#define MQE_QMGR_RULES
 

Rules (ascii).

User replaceable rules which control the capability of the queue manager and queues.

#define MQE_QMGR_CHNLTIMEOUT
 

Channel timeout (long).

Maximum amount of time in milliseconds that a channel will remain open.

#define MQE_QMGR_QUEUES
 

Queues known by queue manager ( fields array - Read Only ).

Field names in a queue array element:

  • Queue manager name ( ascii)
  • Queue name ( ascii)
  • Queue type ( ascii)

#define MQE_QUEUE_QTIMERINTERVAL
 

Process outstanding admin messages after interval (milliseconds) (long).

Resource may end up residing on the admin queue for a period of time if the managed resource was not available when the message was initially processed. Admin messages are processed from 1 to MQeAdminMsg.Admin_MaxAttempts.

#define MQE_QUEUE_QMGRNAME
 

Queue manager that owns the queue (ascii).

Once set the queue manager name cannot be changed. This is also true of the queue name.

#define MQE_QUEUE_FILEDESC
 

File descriptor - location where queue is stored (ascii).

Once set, the file descriptor cannot be re-set. The file descriptor is formed from two parts

  • an adapter
  • the adapter's parameters For example: If alias MsgLog is set to MQeDiskFieldsAdapter then to store messages at d:\ServerQM123\Queues, the filedescriptor would be: MsgLog:d:\ServerQM123\Queues

#define MQE_QUEUE_CRYPTOR
 

Queue security characteristics.

Queue security characteristics:

  • Name of cryptor class (ascii)
  • Name of authenticator class (ascii)
  • Name of compressor class (ascii)
  • Target registry type (byte)
  • Name of queue attribute rules class (ascii) These fields can only be changed when the queue has 0 messages and is not active.

#define MQE_QUEUE_MAXMSGSIZE
 

Maximum length of messages allowed on the queue (int).

Warning:
Note that the size in bytes of a message passed to mqeQueueManager_putMessage() will vary due to system-added header information such as message state or routing information. It will also be affected by user-specified conditions such as compression or encryption.

#define MQE_QUEUE_MODE
 

Type of queue (byte).

Is queue access synchronous or asynchronous?

#define MQE_QUEUE_NOLIMIT
 

Value for no limit.

This can be used with MaxQSize and MaxMsgSize


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