---

T_APPQMSG Class Definition

Overview

The T_APPQMSG class represents messages stored in application queues. A message is not created by an administrator; instead, it comes into existence as a result of a call to tpenqueue(3). A message can be destroyed either by a call to tpdequeue(3) or by an administrator. In addition, certain attributes of a message can be modified by an administrator. For example, an administrator can move a message from one queue to another queue within the same queue space or change its priority.

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_APPQMSG objects in all queues of the specified queue space will be retrieved.

Attribute Table

APPQ_MIB(5): T_APPQMSG Class Definition Attribute Table

Attributea	Type	Permissions	Values	Default
TA_APPQMSGID(k)(*) TA_APPQNAME(k)(*) TA_APPQSPACENAME(k)(*) TA_QMCONFIG(k)(*) TA_LMID(k)(*)b	string string string string string	r--r--r-- r--r--r-- r--r--r-- r--r--r-- r--r--r--	string[1..32] string[1..15] string[1..15] string[1..78] string[1..30]	N/A N/A N/A N/A N/A
TA_STATEc	string	rw-r--r--	GET:{VAL} SET:{INV}	N/A N/A
TA_NEWAPPQNAME TA_PRIORITY TA_TIME	string long string	-w--w---- rw-rw-r-- rw-rw-r--	string[1..15] { 1 = num = 100 | -1 } { YY[MM[DD[hh[mm[ss]]]]] |+seconds }	N/A N/A N/A
TA_CORRID( k ) TA_LOWPRIORITY( k ) TA_HIGHPRIORITY( k ) TA_MSGENDTIME( k ) TA_MSGSTARTTIME( k )	long long long string string	r--r--r-- k--k--k-- k--k--k-- k--k--k-- k--k--k--	string[0..32] 1 = num = 100 1 = num = 100 { YY[MM[DD[hh[mm[ss]]]]] |+seconds } { YY[MM[DD[hh[mm[ss]]]]] |+seconds }	N/A 1 100 MAXLONG 0
TA_CURRETRIES TA_MSGSIZE	long long	r--r--r-- r--r--r--	0 = num 0 = num	N/A N/A
( k ) - GET key fieldd ( * ) - Required SET key field

^a All attributes of class T_APPQMSG are local attributes.

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

^c All operations on T_APPQMSG 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.

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

Attribute Semantics

TA_APPQMSGID: string[1..32]

A unique identifier for the queue message, which can be used to select the message for GET or SET operations. No significance should be placed on this value beyond using it for equality comparisons.

TA_APPQNAME: string[1..15]

Name of the application queue in which the message is stored.

TA_APPQSPACENAME: string[1..15]

Name of the application queue space containing the message.

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 messages. 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 message exists. This state is INActive equivalent for purposes of permissions checking.

SET: {INValid}

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

INValid	The message is deleted from its queue space. The message must be in state VALid before attempting this operation. Successful return leaves the object in the INValid state.
unset	Modify a message. Successful return leaves the state unchanged.

TA_CURRETRIES: 0 = num

The number of retries that have been attempted so far on this message.

TA_CORRID: string[0..32]

The correlation identifier for this message provided by the application in the tpenqueue(3) request. The empty string indicates that a correlation identifier is not present.

TA_LOWPRIORITY: 1 = num = 100
TA_HIGHPRIORITY: 1 = num = 100

The lowest and highest priority within which to search for occurrences of T_APPQMSG objects. These attributes may only be used as key fields with GET operations and are valid only for PRIO-based queues.

TA_MSGSTARTTIME:
TA_MSGENDTIME:

The start and end time within which to search for occurrences of T_APPQMSG objects. The range is inclusive. See TA_TIME for the format. These attributes may only be used as key fields with GET operations and are valid only for TIME-based queues.

TA_NEWAPPQNAME: string[1..15]

Name of the queue into which to move the selected message. This queue must be an existing queue in the same queue space. The message must be in state VALid for this operation to succeed. This attribute is not returned by a GET operation.

TA_PRIORITY: 1 = num = 100

The priority of the message. This attribute is valid only for PRIO-based queues. The value -1 is returned by a GET operation if the queue is not PRIO-based.

TA_TIME:

The time when the message will be processed. This attribute is valid only for TIME-based queues. The empty string is returned by a GET operation if the queue is not TIME-based. The format is one of the following:

+seconds

Specifies that the message will be processed seconds in the future. The value zero specifies that the message should be processed immediately.

YY[MM[DD[hh[mm[ss]]]]]

Specifies the year, month, day, hour, minute, and second when the message should be processed. Omitted units default to their minimum possible values. For example, 9506 is equivalent to 950601000000. The years 00 through 37 are treated as 2000 through 20037, 70 through 99 are treated as 1970 through 1999, and 38 through 69 are invalid.

TA_MSGSIZE: 0 = num

The size of the message, in bytes.

---

---