---

T_APPQ Class Definition

Overview

The T_APPQ class represents application queues. One or more application queues may exist in a single application queue space.

Limitations

It is not possible to retrieve all instances of this class by leaving all key fields unset. Instead, sufficient key fields must be supplied to explicitly target a single application queue space. These required key fields are TA_APPQSPACENAME, TA_QMCONFIG, and TA_LMID, except when the application is unconfigured (i.e., the TUXCONFIG environment variable is not set), in which case TA_LMID must be omitted. For example, if the TA_APPQSPACENAME, TA_QMCONFIG, and TA_LMID attributes are set in a request using tpcall(3), then all T_APPQ objects within the specified queue space will be retrieved.

Attribute Table

APPQ_MIB(5): T_APPQ Class Definition Attribute Table

Attributeaa	Type	Permissions	Values	Default
TA_APPQNAME( k )( r )( * )	string	ru-r--r--	string[1..15]	N/A
TA_APPQSPACENAME( k )( r )( * )	string	ru-r--r--	string[1..15]	N/A
TA_QMCONFIG( k )( r )( * )	string	ru-r--r--	string[1..78]	N/A
TA_LMID( k )( r )( * )b	string	ru-r--r--	string[1..30]	N/A
TA_STATE (Note 3)c	string	rw-r--r--	GET:{VAL} SET:{NEW|INV}	N/A N/A
TA_APPQORDERd	string	rw-r--r--	{PRIO|TIME|LIFO|FIFO}	FIFO
TA_CMD	string	rw-r--r--	shell-command -string[0..78]	""
TA_CMDHW	string	rw-r--r--	0 = num [Bbm%]	100%
TA_CMDLW	string	rw-r--r--	0 = num [Bbm%]	0%
TA_MAXRETRIES	long	rw-r--r--	0 = num	0
TA_OUTOFORDER	string	rw-r--r--	{NONE|TOP |MSGID}	NONE
TA_RETRYDELAY	long	rw-r--r--	0 = num	0
TA_CURBLOCKS	long	r--r--r--	0 = num	N/A
TA_CURMSG	long	r--r--r--	0 = num	N/A
( k ) - GET key field)e ( r ) - Required field for object creation ( * ) - Required SET key field

^aAll attributes of class T_APPQ are local attributes.

^bTA_LMID must be specified as a key field except when the application is unconfigured (i.e., the TUXCONFIG environment variable is not set).

^cAll operations on T_APPQ objects-both GET and SET-silently open the associated queue space (i.e., implicitly set the state of the queue space to OPEn if it is not already OPEn or ACTive). This may be a time-consuming operation if the queue space is large.

^dTA_APPQORDER can not be modified after the application queue is created.

^eSufficient key fields must be supplied in a GET operation to explicitly target a single application queue space.

Attribute Semantics

TA_APPQNAME: string[1..15]

Name of the application queue.

TA_APPQSPACENAME: string[1..15]

Name of the application queue space containing the application queue.

TA_QMCONFIG: string[1..78]

Absolute pathname of the file or device where the application queue space is located.

TA_LMID: string[1..30] (no comma)

Identifier of the logical machine where the application queue space is located.

TA_STATE:

GET: {VALid}

A GET operation retrieves information about the selected application queues. The following list describes the meaning of the TA_STATE attribute returned in response to a GET request. States not listed will not be returned.

VALid

The specified queue exists. This state is INActive equivalent for purposes of permissions checking.

SET: {NEW|INValid}

A SET operation changes characteristics of the selected application queue or creates a new queue. The following list describes the meaning of the TA_STATE attribute returned by a SET request. States not listed can not be set.

NEW	Create a new queue in the specified queue space. The queue is left in state VALid following successful creation.
INValid	Delete the specified queue. The queue must be in state VALid to be deleted. If the queue space has processes attached to it (i.e., it is in the ACTive state), the queue will not be deleted unless the TA_FLAGS attribute includes the QMIB_FORCEDELETE flag. In addition, if the queue has messages in it, it will not be deleted unless QMIB_FORCEPURGE is specified. Successful return leaves the object in the INValid state.
unset	Modify an application queue. Successful return leaves the state unchanged.

TA_APPQORDER:

The order in which messages in the queue are to be processed. Legal values are PRIO or TIME, followed by a comma, optionally followed by another occurrence of PRIO or TIME, followed by one of the values LIFO or FIFO. If neither FIFO nor LIFO is specified, FIFO is assumed. If nothing is specified when a queue is created, the default is FIFO. For example, these are some legal settings:

PRIO
PRIO,TIME,LIFO
TIME,PRIO,FIFO
TIME,FIFO

TA_CMD:shell-command-string[0..78]

The command to be automatically executed when the high water mark, TA_CMDHW, is reached. The command will be re-executed when the high water mark is reached again after the low water mark, TA_CMDLW, has been reached.

TA_CMDHW: 0 = num[Bbm%]

TA_CMDLW: 0 = num[Bbm%]

The high and low water marks that control the automatic execution of the command specified in the TA_CMD attribute. Each is an integer greater than or equal to zero optionally followed by one of the following keyletters. The keyletters must be consistent for TA_CMDHW and TA_CMDLW.

b

The high and low water marks pertain to the number of bytes used by messages in the queue.

B

The high and low water marks pertain to the number of blocks used by messages in the queue.

m

The high and low water marks pertain to the number of messages in the queue.

%

The high and low water marks are expressed in terms of a percentage of queue capacity.

For example, if TA_CMDLW is 50m and TA_CMDHW is 100m, then the command specified in TA_CMD will be executed when 100 messages are on the queue, and it will not be executed again until the queue has been drained below 50 messages and has filled again to 100 messages.

TA_CURBLOCKS: 0 = num

The number of disk pages currently consumed by the queue.

TA_CURMSG: 0 = num

The number of messages currently in the queue.

TA_MAXRETRIES: 0 = num

The maximum number of retries for a failed queue message. When the number of retries is exhausted, the message is placed on the error queue of the associated application queue space. If there is no error queue, the message is dropped. The default is zero.

TA_OUTOFORDER: {MSGID|TOP|NONE}

The way in which out-of-order message processing is to be handled. The default is NONE.

TA_RETRYDELAY: 0 = num

The delay, in seconds, between retries for a failed queue message. The default is zero.

---

---