Table of Contents Previous Next PDF


Application Queue MIB

Application Queue MIB
Oracle Tuxedo systems incorporate the capability to use application queues for time-independent communication. The Tuxedo Application Queue MIB provides the administrative environment required for managing and controlling access to application queues. The Application Queue MIB defines the structure of the application queues.
In Tuxedo applications, messages are stored on a queue, and queues are defined within a particular queue space. Queueing and dequeuing is done within a transaction. The Application Queue MIB consists of five different groups for defining queue access, queues, messages, queues spaces, and queue transactions.
The Application Queue MIB consists of the following groups.
 
tuxTAppQctrl
The tuxTAppQctrl group enables controlled access to all Application Queue related MIB groups.
 
tuxTAppQctrlLmid
Syntax
INTEGER { local(1), all(2) }
Access
read-write
Description
This applies to all Application Queue related MIB groups. This object value controls the machines for which the values are returned.
If the value is local(1), only the local host where Oracle SNMP Agent is running is considered; alternatively, all LMIDs known to the application are considered if the value is all(2).
The default for this object is local(1).
tuxTAppQctrlQmConfig
Syntax
DisplayString (SIZE(1..78))
Access
read-write
Description
This applies to all Application Queue related MIB groups. This object value controls the device for which the values are returned.
The default for this object is “*”, in which case all known devices (which are a part of some group) are considered.
tuxTAppQctrlSpaceName
Syntax
DisplayString (SIZE(1..15))
Access
read-write
Description
This applies to all Application Queue related MIB groups. This object value controls the queue space for which the values are returned.
The default for this object is “*”, in which case all queue spaces for the devices (qualified by tuxTAppQctrlQmConfig) are considered.
tuxTAppQctrlQname
Syntax
DisplayString (SIZE(1..127))
Access
read-write
Description
This object value controls the queue for which the values are returned. This applies to tuxTAppQTbl and tuxTAppQmsgTbl.
The default for this object is “*”, in which case all queues for the devices (qualified by tuxTAppQctrlQmConfig) and queue spaces (qualified by tuxTAppQctrlSpaceName) are considered.
tuxTAppQctrlMsgLoPrio
Syntax
INTEGER
Access
read-write
Description
This object applies only to tuxTAppQmsgTbl. The lowest priority within which to search for occurrences of tuxTAppQmsgTbl instances. This object value is valid only for PRIO-based queues. By default, the minimum value of priority is considered. To revert to the default setting, set this object to 0.
tuxTAppQctrlMsgHiPrio
Syntax
INTEGER
Access
read-write
Description
This object applies only to tuxTAppQmsgTbl. The highest priority within which to search for occurrences of tuxTAppQmsgTbl instances. This object value is valid only for PRIO-based queues. By default, the maximum value of priority is considered. To revert to the default setting, set this object to 0.
tuxTAppQctrlMsgEndTime
Syntax
DisplayString (SIZE(1..15))
Access
read-write
Description
This object applies only to tuxTAppQmsgTbl. The end time within which to search for occurrences of tuxTAppQmsgTbl instances. The range is inclusive. This object value is valid only for TIME-based queues. The default value is the maximum number possible on that machine. To use the default setting, set this object to “*”.
YY[MM[DD[hh[mm[ss]]]]]
Specifies the year, month, date, hour, minute, and second respectively. Any value which is not specified defaults to its minimum value (e.g., 9506 is taken as 950601000000). The years 00 through 37 are treated as 2000 through 2037, 70 through 99 as 1970 through 1999, and 38 through 69 are invalid.
tuxTAppQctrlMsgStartTime
Syntax
DisplayString (SIZE(1..15))
Access
read-write
Description
This object applies only to tuxTAppQmsgTbl. The start time within which to search for occurrences of tuxTAppQmsgTbl instances. The range is inclusive. This object value is valid only for TIME-based queues. By default, the minimum time value is considered to be 0. To use the default setting, set this object to “*”.
YY[MM[DD[hh[mm[ss]]]]]
Specifies the year, month, date, hour, minute, and second respectively. Any value which is not specified defaults to its minimum value (e.g., 9506 is taken as 950601000000). The years 00 through 37 are treated as 2000 through 2037, 70 through 99 as 1970 through 1999, and 38 through 69 are invalid.
tuxTAppQctrlMsgExpireEndTime
Syntax
DisplayString (SIZE(1..12))
Access
read-write
Description
This object applies only to tuxTAppQmsgTbl. The expire end time within which to search for occurrences of tuxTAppQmsgTbl instances. The range is inclusive. This object value is valid only for TIME-based queues. The default value is the maximum number possible on that machine. To use the default setting, set this object to “*”.
YY[MM[DD[hh[mm[ss]]]]]
Specifies the year, month, date, hour, minute, and second respectively. Any value which is not specified defaults to its minimum value (e.g., 9506 is taken as 950601000000). The years 00 through 37 are treated as 2000 through 2037, 70 through 99 as 1970 through 1999, and 38 through 69 are invalid.
tuxTAppQctrlMsgExpireStartTime
Syntax
DisplayString (SIZE(1..12))
Access
read-write
Description
This object applies only to tuxTAppQmsgTbl. The Expire start time within which to search for occurrences of tuxTAppQmsgTbl instances. The range is inclusive. This object value is valid only for TIME-based queues. By default, the minimum time value is considered to be 0. To use the default setting, set this object to “*”.
YY[MM[DD[hh[mm[ss]]]]]
Specifies the year, month, date, hour, minute, and second respectively. Any value which is not specified defaults to its minimum value (e.g., 9506 is taken as 950601000000). The years 00 through 37 are treated as 2000 through 2037, 70 through 99 as 1970 through 1999, and 38 through 69 are invalid.
tuxTAppQTbl
The tuxTAppQTbl group contains objects that represent application queues. One or more application queues can exist in a single application queue space. Objects in this table are only accessible through a Tuxedo SNMP agent installed on the local machine.
Creation of a New Queue — For creating a new queue(row), in this group the SET request should have the value of tuxTAppQname, tuxTAppQspaceName, and tuxTAppQmConfig. Also the value of tuxTAppQgrpNo (which is a part of the index) should be the corresponding group number for that queue space or “40000” (if no such group exists).
Note:
To create a new row in this table, issue a SET request that specifies at least the values for tuxTAppQname, tuxTAppQspaceName, and tuxTAppQmConfig.
 
tuxTAppQname
Syntax
DisplayString (SIZE(1..127))
Access
read-write
Description
Name of the application queue.
Note:
tuxTAppQspaceName
Syntax
DisplayString (SIZE(1..15))
Access
read-write
Description
Name of the application queue space containing the application queue.
Note:
tuxTAppQmConfig
Syntax
DisplayString (SIZE(1..78))
Access
read-write
Description
Absolute pathname of the file or device where the application queue space is located.
Note:
tuxTAppQlmid
Syntax
DisplayString (SIZE(1..30))
Access
read-write
Description
Identifier of the logical machine where the application queue space is located.
Note:
tuxTAppQgrpNo
Syntax
INTEGER (1..29999)
Access
read-write
Description
Group number of any server group for which this queue is a resource manager, in other words that group’s openinfo string tuxTgroupOpenInfo contains the device name and queue space name for this queue.
Note:
tuxTAppQstate
Syntax
INTEGER { valid(1), invalid(2) }
Access
read-write
Description
The values for GET and SET operations are as follows:
GET: valid(1)
A GET operation retrieves information about the selected application queues. The following list describes the meaning of the tuxTAppQstate object returned in response to a GET request. States not listed are not returned.
valid(1)
The specified queue exists.
SET: invalid(2)
A SET operation changes characteristics of the selected application queue or creates a new queue. The following list describes the meaning of the tuxTAppQstate object returned by a SET request. States not listed cannot be set.
invalid(2)
Delete the specified queue. If the queue space has processes attached to it, the queue is not deleted. In addition, if the queue has messages in it, it is not deleted. Successful return leaves the object in the invalid(2) state.
tuxTAppQorder
Syntax
DisplayString (SIZE(1..30))
Access
read-write
Description
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
tuxTAppQcmd
Syntax
DisplayString (SIZE(0..127)) (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Access
read-write
Description
The command to be automatically executed when the high water mark, tuxTAppQcmdHw, is reached. The command is re-executed when the high water mark is reached again after the low water mark, tuxTAppQcmdLw, has been reached.
tuxTAppQcmdHw
Syntax
DisplayString
Access
read-write
Description
The high water mark. Refer to tuxTAppQcmdLw for further information.
tuxTAppQcmdLw
Syntax
DisplayString
Access
read-write
Description
The low water marks that control the automatic execution of the command specified in the tuxTAppQcmd object. Each is an integer greater than or equal to zero optionally followed by one of the following keyletters. The keyletters must be consistent for tuxTAppQcmdHw and tuxTAppQcmdLw.
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 tuxTAppQcmdLw is 50m and tuxTAppQcmdHw is 100m, then the command specified in tuxTAppQcmd is executed when 100 messages are on the queue, and it is not executed again until the queue is drained below 50 messages and is filled again to 100 messages.
tuxTAppQmaxRetries
Syntax
INTEGER
Access
read-write
Description
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.
tuxTAppQoutOfOrder
Syntax
INTEGER { none(1), top(2), msgid(3) }
Access
read-write
Description
The way in which out-of-order message processing is to be handled. The default is none(1).
tuxTAppQretryDelay
Syntax
INTEGER
Access
read-write
Description
The delay, in seconds, between retries for a failed queue message. The default is zero.
tuxTAppQcurBlocks
Syntax
INTEGER
Access
read-only
Description
The number of disk pages currently consumed by the queue.
tuxTAppQcurMsg
Syntax
INTEGER
Access
read-only
Description
The number of messages currently in the queue.
tuxTAppQDefExpirationTime
Syntax
DisplayString
Access
read-write
Description
This object specifies an expiration time for messages enqueued with no explicit expiration time. The expiration time can be either a relative expiration time or none. The relative expiration time is determined by associating a fixed amount of time with a message after the message arrives at the queue manager process. When a message’s expiration time is reached and the message has not been dequeued or administratively deleted, all resources associated with the message are reclaimed by the system and statistics are updated. If a messages expires during a transaction, the expiration does not cause the transaction to fail. Messages that expire while being enqueued or dequeued within a transaction are removed from the queue when the transaction ends. There is no notification that the message has expired. If no default expiration time is specified for a queue, the message without an explicit expiration time does not expire. When the queue’s expiration time is modified, the expiration times of messages that were in the queue before the modification are not changed.
The format is +seconds, where seconds is the number of seconds allowed to lapse between the time that the queue manager successfully completes the operation and the time that the message is to expire. If seconds is set to zero (0), the message expires immediately.
The value of this object may also be set to the string “none.” The none string indicates that messages enqueued to the queue with no explicit expiration time do not expire. You can change the expiration time for messages already in a queue with the tuxTAppQmsgExpireTime object of the tuxTAppQmsgTbl group.
tuxTAppQDefDeliveryPolicy
Syntax
INTEGER { persist(1), non-persist(2) }
Access
read-write
Description
This object specifies the default delivery policy for the queue when no delivery mode is specified for a message enqueued to the queue. When the value is “persist,” messages enqueued to the queue without an explicitly specified delivery mode are delivered using the persistent (disk-based) delivery method. When the value is non-persist, messages enqueued to the queue without an explicitly specified delivery method are delivered using the non-persistent (in memory) delivery method. When a queue’s default delivery policy is modified, the delivery quality of service of messages that are in the queue before the modification are not changed. If the queue being modified is the reply queue named for any messages currently in the queue space, the reply quality of service is not changed for those messages as a result of changing the default delivery policy of the queue.
For non-persistent delivery, if the memory area is exhausted or fragmented so that a message cannot be enqueued, the enqueuing operation fails, even if there is sufficient persistent storage for the message. Similarly, if the persistent storage area is exhausted or fragmented so that a message cannot be enqueued, the enqueuing operation fails, even if there is sufficient non-persistent storage for the message. If the tuxTQspaceMemNonPersist object of the tuxTQspaceTbl group is zero (0) for a queue space, no space is reserved for non -persistent messages. In such a case, any attempt to enqueue a non-persistent message fails. This type of failure results, for example, when no delivery quality of service has been specified for a message and the tuxTAppQDefDeliveryPolicy object for the target queue has been set to “non-persist.”
tuxTAppQCmdNonPersist
Syntax
DisplayString (SIZE(1..127)) (up to 78 bytes for Oracle Tuxedo 8.0 or earlier)
Access
read-write
Description
This object specifies the command to be executed automatically when the high-water mark for non -persistent (memory-based delivery) messages, tuxTAppQCmdNonPersistHw, is reached. The command is re-executed when the high-water mark is reached again after the low-water mark for non-persistent (memory-based delivery) messages, tuxTAppQCmdNonPersistLw, has been reached.
tuxTAppQCmdNonPersistHw
Syntax
DisplayString
Access
read-write
Description
These objects specify the high- and low-water marks that control the automatic execution of the command specified in the tuxTAppQCmdNonPersist object. Each is an integer greater than or equal to zero, followed by one of the following keyletters. The keyletters must be consistent for tuxTAppQCmdNonPersistHw and tuxTAppQCmdNonPersistLw.
b
The high- and low-water marks are expressed as the number of bytes used by non-persistent (in-memory) messages in the queue.
B
The high- and low-water marks are expressed as the number of blocks used by non-persistent (in-memory) messages in the queue.
%
The high- and low-water marks are expressed as a percentage of the shared memory capacity reserved for non-persistent messages in the queue space used by the queue.
The messages threshold type specified through the tuxTAppQCmdHw and tuxTAppQcmdLw objects (when followed by an m) applies to all messages in a queue, including both persistent and non-persistent messages, and therefore is not available as a threshold type for tuxTAppQCmdNonPersistHw and tuxTAppQCmdNonPersistLw.
tuxTAppQCmdNonPersistLw
Syntax
DisplayString
Access
read-write
Description
These objects specify the high- and low-water marks that control the automatic execution of the command specified in the tuxTAppQCmdNonPersist object. Each is an integer greater than or equal to zero, followed by one of the following keyletters. The keyletters must be consistent for tuxTAppQCmdNonPersistHw and tuxTAppQCmdNonPersistLw.
b
The high- and low-water marks are expressed as the number of bytes used by non-persistent (in-memory) messages in the queue.
B
The high- and low-water marks are expressed as the number of blocks used by non-persistent (in-memory) messages in the queue.
%
The high- and low-water marks are expressed as a percentage of the shared memory capacity reserved for non-persistent messages in the queue space used by the queue.
The messages threshold type specified through the tuxTAppQCmdHw and tuxTAppQcmdLw objects (when followed by an m) applies to all messages in a queue, including both persistent and non-persistent messages, and therefore is not available as a threshold type for tuxTAppQCmdNonPersistHw and tuxTAppQCmdNonPersistLw.
tuxTAppQCurNonPersistBytes
Syntax
INTEGER
Access
read-write
Description
This object specifies the number of shared memory bytes currently consumed by the non-persistent messages on the queue.
tuxTAppQCurNonPersistMsg
Syntax
INTEGER
Access
read-write
Description
This object specifies the number of non-persistent messages currently in the queue. To determine the total number of messages in the queue, add the value of tuxTAppQcurMsg to this value.
tuxTAppQmsgTbl
The tuxTAppQmsgTbl group contains objects that represent 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 objects 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.
Objects in this table are only accessible through a Tuxedo SNMP agent installed on the local machine.
 
tuxTAppQmsgId
Syntax
DisplayString (SIZE(1..32))
Access
read-only
Description
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.
tuxTAppQmsgSerNo
Syntax
INTEGER
Access
read-only
Description
A running number corresponding to tuxTAppQmsgId for the queue message, which is a part of the composite index of this table.
tuxTAppQmsgGrpNo
Syntax
INTEGER
Access
read-only
Description
Group number of any server group for which this queue is a resource manager, in other words that group’s openinfo string tuxTgroupOpenInfo contains the device name and queue space name for this queue.
tuxTAppQmsgQname
Syntax
DisplayString (SIZE(1..127))
Access
read-only
Description
Name of the application queue in which the message is stored.
tuxTAppQmsgQmConfig
Syntax
DisplayString (SIZE(1..78))
Access
read-only
Description
Absolute pathname of the file or device where the application queue space for the queue containing this message is located.
tuxTAppQmsgQspaceName
Syntax
DisplayString (SIZE(1..15))
Access
read-only
Description
Name of the application queue space containing the application queue in which this message is located.
tuxTAppQmsgLmid
Syntax
DisplayString (SIZE(1..30))
Access
read-only
Description
Logical machine id for the machine on which the queue containing this message is located.
tuxTAppQmsgState
Syntax
INTEGER { valid(1), invalid(2) }
Access
read-write
Description
The values for GET and SET operations are as follows:
GET: valid(1)
A GET operation retrieves information about the selected messages. The following list describes the meaning of the tuxTAppQmsgState object returned in response to a GET request. States not listed are not returned.
valid(1)
The message exists.
SET: invalid(2)
A SET operation changes characteristics of the selected message. The following list describes the meaning of the tuxTAppQmsgState object returned by a SET request. States not listed cannot be set.
invalid(2)
The message is deleted from its queue space. The message must be in state valid(1) before attempting this operation. Successful return leaves the object in the invalid(2) state.
tuxTAppQmsgNewQname
Syntax
DisplayString (SIZE(1..15))
Access
read-write
Description
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(1) for this operation to succeed. This object value is not returned by a GET operation.
tuxTAppQmsgPrior
Syntax
INTEGER
Access
read-write
Description
The priority of the message. This object value is valid only for PRIO-based queues. The value -1 is returned by a GET operation if the queue is not PRIO-based.
tuxTAppQmsgTime
Syntax
DisplayString (SIZE(1..15))
Access
read-write
Description
The time when the message is processed. This object value 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 is 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.
tuxTAppQmsgCorId
Syntax
DisplayString (SIZE(0..32))
Access
read-only
Description
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.
tuxTAppQmsgCurRetries
Syntax
INTEGER
Access
read-only
Description
The number of retries that have been attempted so far on this message.
tuxTAppQmsgSize
Syntax
INTEGER
Access
read-only
Description
The size of the message, in bytes.
tuxTAppQmsgExpireTime
Syntax
DisplayString (SIZE(1..15))
Access
read-write
Description
This object specifies the time at which a message expires (that is, the time at which the message should be removed from the queue if it has not already been dequeued or administratively deleted). When a message expires, all resources it uses are reclaimed by the system and statistics are updated. If a message expires during a transaction, the expiration does not cause the transaction to fail. Messages that expire while being enqueued or dequeued within a transaction are removed from the queue when the transaction ends. There is no notification that the message has expired. Expiration times cannot be added to messages enqueued by versions of the Oracle Tuxedo system that do not support message expiration, even when the queue manager responsible for changing this value supports message expiration. Attempts to add an expiration time fail.
The empty string is returned by a GET operation if the expiration time is not set. The expiration time format is one of the following:
+seconds
Specifies that the message will be removed after the specified number of seconds. If the value of seconds is set to zero (0), the message is removed immediately from the queue. Relative expiration time is calculated on the basis of the time at which the MIB request arrives and has been processed by the corresponding queue manager.
YY[MM[DD[hh]MM[SS]]]]
Specifies the year, month, day, hour, minute, and second when the message will be removed if it has not already been dequeued or administratively deleted. 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 2037, 70 through 99 are treated as 1970 through 1999, and 38 through 69 are invalid. An absolute expiration time is determined by the clock on the machine where the queue manager process resides.
none
Specifies that the message will never expire.
tuxTAppQmsgPersistent
Syntax
INTEGER { yes(1), no(2) }
Access
read-only
Description
This read-only state is set to “no” for non-persistent messages and “yes” for persistent messages. It is the delivery quality of service for the message.
tuxTAppQmsgReplyPersistent
Syntax
INTEGER { yes(1), no(2) }
Access
read-only
Description
This read-only state is set to “no” for non-persistent messages and “yes” for persistent messages. It is the delivery quality that replies to the message
tuxTQspaceTbl
The tuxTQspaceTbl group contains objects that represent application queue spaces. Objects in this table are only accessible through a Tuxedo SNMP agent installed on the local machine.
Note:
The values returned by this MIB are controlled by tuxTAppQctrl. For details, see the description of the above group.
To create a new row in this table, a SET request should be issued with an index (tuxTQspaceGrpNo) of 40000, which is a reserved value for row creation in the table. The SET request also needs to specify values for at least tuxTQspaceQmConfig, tuxTQspaceName, tuxTQspaceLmid, tuxTQspaceIpckey, tuxTQspaceMaxMsg, tuxTQspaceMaxPages, tuxTQspaceMaxProc, tuxTQspaceMaxQueues, and tuxTQspaceMaxTrans. The newly created instance (row) is not visible until it is attached to some server group.
 
tuxTQspaceName
Syntax
DisplayString (SIZE(1..15))
Access
read-write
Description
Name of the application queue space.
Note:
tuxTQspaceQmConfig
Syntax
DisplayString (SIZE(1..78))
Access
read-write
Description
Absolute pathname of the file or device where the application queue space is located.
Note:
tuxTQspaceLmid
Syntax
DisplayString (SIZE(1..30))
Access
read-write
Description
Identifier of the logical machine where the application queue space is located.
Note:
tuxTQspaceGrpNo
Syntax
INTEGER (1..29999)
Access
read-write
Description
Group number of any server group for which this queue space is a resource manager, in other words that group’s openinfo string tuxTgroupOpenInfo contains the device name and queue space name for this queue space.
Note:
tuxTQspaceState
Syntax
INTEGER { inactive(1), initializing(2), open(3), active(4), cleaning(5), invalid(6) }
Access
read-write
Description
The values for GET and SET operations are as follows:
GET: inactive(1)|initializing(2)|open(3)|active(4)
A GET operation retrieves information about the selected application queue space. The following list describes the meaning of the tuxTQspaceState object returned in response to a GET request. States not listed are not returned.
inactive(1)
The queue space exists; i.e., disk space for it has been reserved in a device and the space has been initialized (if requested or if necessary).
initializing(2)
Disk space for the queue space is currently being initialized.
open(3)
Shared memory and other IPC resources for the queue space have been allocated and initialized, but no processes are currently attached to the shared memory.
active(4)
Shared memory and other IPC resources for the queue space have been allocated and initialized, and at least one process is currently attached to the shared memory. These processes can be the queue servers (TMS_QM, TMQUEUE, and perhaps TMQFORWARD) associated with the queue space, or they can be administrative processes such as qmadmin(1), or they can be processes associated with another application.
SET: open(3)|cleaning(5)|invalid(6)
A SET operation changes the selected application queue space or creates a new one. The following list describes the meaning of the tuxTQspaceState object returned by a SET request. States not listed cannot be set.
open(3)
Allocate and initialize shared memory and other IPC resources for the queue space, which is allowed only if the queue space is in the inactive(1) state.
cleaning(5)
Remove the shared memory and other IPC resources for the queue space, which is allowed only when the queue space is in the active(4) or open(3) state. Successful return leaves the object in the inactive(1) state.
invalid(6)
Delete the queue space. An error is reported if the state is active(4) or if messages exist on any queues in the queue space. Successful return leaves the object in the invalid(6) state.
tuxTQspaceBlocking
Syntax
INTEGER
Access
read-write
Description
The blocking factor used for disk space management of the queue space. The default when a new queue space is created is 16.
tuxTQspaceErrQname
Syntax
DisplayString (SIZE(0..127))
Access
read-write
Description
Name of the error queue associated with the queue space. If there is no error queue, an empty string is returned by a GET request.
tuxTQspaceForceInit
Syntax
INTEGER { yes(1), no(2) }
Access
read-write
Description
This object value determines whether or not to initialize disk pages on new extents for the queue space. The default is not to initialize. Depending on the device type (e.g., regular file or raw slice), initialization can occur even if not requested.
tuxTQspaceIpckey
Syntax
INTEGER (32769..262143)
Access
read-write
Description
The IPC key used to access queue space shared memory.
tuxTQspaceMaxMsg
Syntax
INTEGER
Access
read-write
Description
The maximum number of messages that the queue space can contain.
tuxTQspaceMaxPages
Syntax
INTEGER
Access
read-write
Description
The maximum number of disk pages for all queues in the queue space. Each time the tuxTQspaceMaxPages object is increased, a new extent is allocated (see tuxTQspaceCurExtent). It is not possible to decrease the number of pages by setting this object to a lower number; an error is reported in this case.
tuxTQspaceMaxProc
Syntax
INTEGER
Access
read-write
Description
The maximum number of processes that can attach to the queue space.
tuxTQspaceMaxQueues
Syntax
INTEGER
Access
read-write
Description
The maximum number of queues that the queue space can contain.
tuxTQspaceMaxTrans
Syntax
INTEGER
Access
read-write
Description
The maximum number of simultaneously active transactions allowed by the queue space.
tuxTQspaceCurExtent
Syntax
INTEGER
Access
read-only
Description
The current number of extents used by the queue space. The largest number allowed is 100. Each time the tuxTQspaceMaxPages object is increased, a new extent is allocated.
tuxTQspaceCurMsg
Syntax
INTEGER
Access
read-only
Description
The current number of messages in the queue space. This number can be determined only if the queue space is open(3) or active(4), or if the queue space is newly created. If none of the conditions apply, the value -1 is returned.
tuxTQspaceCurProc
Syntax
INTEGER
Access
read-only
Description
The current number of processes accessing the queue space.
tuxTQspaceCurQueues
Syntax
INTEGER
Access
read-only
Description
The current number of queues existing in the queue space. This number can be determined only if the queue space is open(3) or active(4), or if the queue space is newly created. If none of these conditions apply, the value -1 is returned.
tuxTQspaceCurTrans
Syntax
INTEGER
Access
read-only
Description
The current number of outstanding transactions involving the queue space.
tuxTQspaceHwMsg
Syntax
INTEGER
Access
read-only
Description
The highest number of messages in the queue space since the queue space was last opened. The number is reset to 0 when the queue space state is set to cleaning(5).
tuxTQspaceHwProc
Syntax
INTEGER
Access
read-only
Description
The highest number of processes simultaneously attached to the queue space since the queue space was last opened. The number is reset to 0 when the queue space state is set to cleaning(5).
tuxTQspaceHwQueues
Syntax
INTEGER
Access
read-only
Description
The highest number of queues existing in the queue space since the queue space was last opened. The number is reset to 0 when the queue space state is set to cleaning(5).
tuxTQspaceHwTrans
Syntax
INTEGER
Access
read-only
Description
The highest number of outstanding transactions involving the queue space since the queue space was last opened. If the queue space is accessed by more than one application, this number reflects all applications — not just the application represented by the TUXCONFIG environment variable. The number is reset to 0 when the queue space state is set to cleaning(5).
tuxTQspacePercentInit
Syntax
INTEGER (0..100)
Access
read-only
Description
The percentage (as an integer between 0 and 100 inclusive) of disk space that has been initialized for the queue space.
tuxTQspaceMaxActions
Syntax
INTEGER
Access
read-write
Description
This object specifies the number of additional actions that the Queuing Services component of the Oracle Engine can handle concurrently. When a blocking operation is encountered and additional actions are available, the blocking operation is set aside until it can be satisfied. After setting aside the blocking operation, another operation request can be handled. When the blocking operation is completed, the action associated with the operation is made available for a subsequent operation. The system reserve actions are equivalent to the number of processes that can attach to a queue space, so that each queue manager process can have at least one blocking action. Beyond the system-reserved number of blocking actions, the administrator can configure the system to enable it to accommodate additional blocking actions beyond the reserve. An operation fails if a blocking operation is requested and cannot be immediately satisfied and there are no actions available.
tuxTQspaceMaxHandles
Syntax
INTEGER
Access
read-write
Description
This object specifies the number of handles that users of the Queueing Services component of the Oracle Engine can use concurrently. Objects manipulated by the queuing services API require handles to access the objects. When an object is opened by a call to the Queuing Services API, a new handle is created and returned to the user. When an object handle is closed, the handle is made available for subsequent open object operations. When the Queuing Services API is used by an application, the administrator must configure the system to accommodate the maximum number of handles that are opened concurrently. An operation fails if a user attempts to open a queuing services object and there are no handles available. Adjusting this value has no effect on Tuxedo applications other than unnecessarily consuming shared memory resources.
tuxTQspaceMaxOwners
Syntax
INTEGER
Access
read-write
Description
This object specifies the number of additional Oracle Engine authenticated users that can concurrently use Queuing Services resources. There is one owner record per user, regardless of the number of open handles for the user. When there are no open handles for a user, the owner record is made available to subsequent users. The system reserves a number of owners equivalent to the number of actions, so that each action can be initiated by a different owner. Beyond the system-reserved number of owners that can concurrently use queuing services resources, the administrator can configure the system to accommodate additional owners beyond the reserved number. An operation fails if a user attempts to open a handle when there currently are no open handles, and there are no owners available. Adjusting this value has no effect on Oracle Tuxedo applications other than unnecessarily consuming shared memory resources. Adjusting this value has no effect on Tuxedo applications other than unnecessarily consuming shared memory resources.
tuxTQspaceMaxTmpQueues
Syntax
INTEGER
Access
read-write
Description
This object specifies the number of temporary queues that can be opened concurrently in the Queuing Services component of the Oracle Engine. Temporary queues are used by dynamic, self-configuring applications and reduce the need for administrators to configure each queue used by an application. Messages enqueued to temporary queues are not persistent. When all handles to a temporary queue are closed, the temporary queue resources are made available for subsequent temporary queue creation. When the temporary queues are used by an application, the administrator must configure the system to accommodate the maximum number of temporary queues that are active concurrently. An open operation fails if a user attempts to open a temporary queue and there are no temporary queue resources available. This object specifies the number of additional Oracle Engine authenticated users that can concurrently use Queuing Services
tuxTQspaceMaxCursors
Syntax
INTEGER
Access
read-write
Description
This object specifies the number of cursors that user of the Queuing Services component of the Oracle Engine can use concurrently. CUrsors are used to navigate a queue. When a cursor is destroyed, the cursor resources are made available for subsequent cursor creation operations. When the cursors are used by an application, the administrator must configure the system to accommodate the maximum number of cursors that are allocated concurrently. An operation fails if a user attempts to create a cursor and there are no cursor resources available. This object specifies the number of additional Oracle Engine authenticated users that can concurrently use Queuing Services.
tuxTQspaceMemNonPersist
Syntax
DisplayString
Access
read-write
Description
This object specifies the size of the area reserved in shared memory to hold non-persistent messages for all queues in the queue space. The memory size can be specified in bytes (b) or blocks (B). (The size of a block in this context is equivalent to the size of a disk block.)
The [bB]suffix is optional and, if not specified, the default is blocks. Note that the number of bytes requested can be rounded up to the next internal data size. When read, the value is always the actual amount of memory allocated in bytes (b).
All non-persistent messages in the specified queue space are permanently lost when this variable is successfully changed.
If the variable for a queue space is zero (0), no queue space is reserved. for non-persistent messages. In this case, any attempt to enqueue a non-persistent message fails. This type of failure results, for example, when no delivery quality of service has been specified for a message and the tuxTAppQDefDeliverPolicy object of the tuxTAppTbl group for the target queue has been set to NONPERSIST. For non-persistent delivery, if the memory area is exhausted or fragmented so that a message cannot be enqueued, the enqueuing operation fails, even if there is sufficient persistent storage for the message. Similarly, if the persistent storage area is exhausted or fragmented so that a message cannot be enqueued, the enqueuing operation fails, even if there is sufficient non-persistent storage for the message.
tuxTQspaceMemFilters
Syntax
INTEGER
Access
read-write
Description
This object specifies the size of the memory area to reserve in shared memory to hold the compiled representation of user-defined filters. The memory size is specified in bytes. Filters are used by the Queuing Services component of the Oracle Engine for message selection in dequeuing and cursor operations. Filters can be specified using various grammars, but are compiled into an engine normal form and stored in shared memory. Filters are referenced by a handle that is returned when they are compiled. When a filter is destroyed, the memory used by the filter is made available for subsequent compiled filters. When the filters are defined by an application, the administrator must configure the system to accommodate the maximum number of filters that will be concurrently compiled. An operation fails if a user attempts to create a new filter and there is not enough memory allocated for the compiled version of the filter. Adjusting this value has no effect on Tuxedo applications other than unnecessarily consuming shared memory resources.
tuxTQspaceMemOverFlow
Syntax
INTEGER
Access
read-write
Description
This object specifies the size of the memory area to reserve in shared memory to accommodate peak load situations where some or all of the allocated shared memory resources are exhausted. The memory size is specified in bytes. Additional objects are allocated from this additional memory on a first-come, first-served basis. When an object created in the additional memory is closed or destroyed, the memory is released for subsequent overflow situations. This additional memory space can yield more objects than the configured number, but there is no guarantee that additional memory is available for any particular object at any given point in time. Currently, only actions, handles, cursors, owners, temporary queues, timers, and filters use the overflow.
tuxTQspaceMemSystemReserved
Syntax
INTEGER
Access
read-only
Description
This object specifies the total amount of memory (in bytes) reserved from shared memory for queuing services system use.
tuxTQspaceMemTotalAllocated
Syntax
INTEGER
Access
read-only
Description
This object specifies the total amount of memory (in bytes) allocated from shared memory for all queuing services objects.
tuxTQspaceCurActions
Syntax
INTEGER
Access
read-only
Description
This object specifies the current number of actions in use in the queue space. This number can be determined if the queue space is OPEn or ACTive, or if the queue space is newly created. If none of the conditions apply, the value -1 is returned.
tuxTQspaceCurHandles
Syntax
INTEGER
Access
read-only
Description
This object specifies the current number of cursors in use in the queue space. This number can be determined if the queue space is OPEn or ACTive, or if the queue space is newly created. If none of the conditions apply, the value -1 is returned.
tuxTQspaceCurOwners
Syntax
INTEGER
Access
read-only
Description
This object specifies the current number of owners in use in the queue space. This number can be determined if the queue space is OPEn or ACTive, or if the queue space is newly created. If none of the conditions apply, the value -1 is returned.
tuxTQspaceCurTmpQueues
Syntax
INTEGER
Access
read-only
Description
This object specifies the current number of temporary queues in use in the queue space. This number can be determined if the queue space is OPEn or ACTive, or if the queue space is newly created. If none of the conditions apply, the value -1 is returned.
tuxTQspaceCurCursors
Syntax
INTEGER
Access
read-only
Description
This object specifies the current number of cursors in use in the queue space. This number can be determined if the queue space is OPEn or ACTive, or if the queue space is newly created. If none of the conditions apply, the value -1 is returned.
tuxTQspaceCurMemNonPersist
Syntax
INTEGER
Access
read-only
Description
This object specifies the current amount of memory, in bytes, consumed by non-persistent messages in the queue space. This number can be determined if the queue space is OPEn or ACTive, or if the queue space is newly created. If none of the conditions apply, the value -1 is returned.
tuxTQspaceCurMemFilters
Syntax
INTEGER
Access
read-only
Description
This object specifies the current number of bytes in use for filters in the queue space. This number can be determined if the queue space is OPEn or ACTive, or if the queue space is newly created. If none of the conditions apply, the value -1 is returned.
tuxTQspaceCurMemOverFlow
Syntax
INTEGER
Access
read-only
Description
This object specifies the current number of bytes of overflow memory in use in the queue space. This number can be determined if the queue space is OPEn or ACTive, or if the queue space is newly created. If none of the conditions apply, the value -1 is returned.
tuxTQspaceHwActions
Syntax
INTEGER (0..100)
Access
read-only
Description
This object specifies the highest number of concurrent actions reached in the queue space since the queue space was last opened. The number is reset to 0 when the queue space is set to CLEaning.
tuxTQspaceHwHandles
Syntax
INTEGER (0..100)
Access
read-only
Description
This object specifies the highest number of concurrent handles opened in the queue space since the queue space was last opened. The number is reset to 0 when the queue space is set to CLEaning.
tuxTQspaceHwOwners
Syntax
INTEGER
Access
read-only
Description
This object specifies the highest number of concurrent owners reached in the queue space since the queue space was last opened. The number is reset to 0 when the queue space is set to CLEaning.
tuxTQspaceHwTmpQueues
Syntax
INTEGER
Access
read-only
Description
This object specifies the highest number of concurrent temporary queues opened in the queue space since the queue space was last opened. The number is reset to 0 when the queue space is set to CLEaning.
tuxTQspaceHwCursors
Syntax
INTEGER
Access
read-only
Description
This object specifies the highest number of concurrent cursors created in the queue space since the queue space was last opened. The number is reset to 0 when the queue space is set to CLEaning.
tuxTQspaceHwMemNonPersist
Syntax
INTEGER
Access
read-only
Description
This object specifies the largest amount of memory in bytes consumed by non-persistent messages since the queue space was last opened. The number is reset to 0 when the queue space is set to CLEaning.
tuxTQspaceHwMemFilters
Syntax
INTEGER
Access
read-only
Description
This object specifies the highest number of bytes used for filters in the queue space since the queue space was last opened. The number is reset to 0 when the queue space is set to CLEaning.
tuxTQspaceHwMemOverflow
Syntax
INTEGER
Access
read-only
Description
This object specifies the highest number of bytes used in the overflow memory in the queue space since the queue space was last opened. The number is reset to 0 when the queue space is set to CLEaning.
tuxTQtransTbl
The tuxTQtransTbl group contains objects that represent run-time characteristics of transactions associated with application queue spaces. Objects in this table are only accessible through a Tuxedo SNMP agent installed on the local machine.
 
tuxTQtransXid
Syntax
DisplayString (SIZE(1..78))
Access
read-only
Description
Transaction identifier as returned by tx_info(3) and mapped to a string representation. The data in this field should not be interpreted directly by the user except for equality comparison.
tuxTQtransIndx1
Syntax
INTEGER
Access
read-only
Description
An integer index for tuxTQtransTbl. This should not be interpreted by the user. It is used only for uniquely identifying a particular row in this table by the combination of Indx1 through Indx5.
tuxTQtransIndx2
Syntax
INTEGER
Access
read-only
Description
An integer index for tuxTQtransTbl. This should not be interpreted by the user. It is used only for uniquely identifying a particular row in this table by the combination of Indx1 through Indx5.
tuxTQtransIndx3
Syntax
INTEGER
Access
read-only
Description
An integer index for tuxTQtransTbl. This should not be interpreted by the user. It is used only for uniquely identifying a particular row in this table by the combination of Indx1 through Indx5.
tuxTQtransIndx4
Syntax
INTEGER
Access
read-only
Description
An integer index for tuxTQtransTbl. This should not be interpreted by the user. It is used only for uniquely identifying a particular row in this table by the combination of Indx1 through Indx5.
tuxTQtransIndx5
Syntax
INTEGER
Access
read-only
Description
An integer index for tuxTQtransTbl. This should not be interpreted by the user. It is used only for uniquely identifying a particular row in this table by the combination of Indx1 through Indx5.
tuxTQtransGrpNo
Syntax
INTEGER
Access
read-only
Description
Group number of any server group for which the queue space concerning this transaction is a resource manager, in other words that group’s openinfo string tuxTgroupOpenInfo contains the device name and queue space name for the queue space concerning this transaction.
tuxTQtranSpaceName
Syntax
DisplayString (SIZE(1..15))
Access
read-only
Description
Name of the application queue space associated with the transaction.
tuxTQtransQmConfig
Syntax
DisplayString (SIZE(1..78))
Access
read-only
Description
Absolute pathname of the file or device where the application queue space is located.
tuxTQtransLmid
Syntax
DisplayString (SIZE(1..30))
Access
read-only
Description
Identifier of the logical machine where the application queue space is located.
tuxTQtransState
Syntax
INTEGER { active(1), abort-only(2), aborted(3), com-called(4), ready(5), decided(6), suspended(7), habort(8), hcommit(9) }
Access
read-write
Description
The values for GET and SET operations are as follows:
GET: {actdive(1)|abort-only(2)|aborted(3)|com-called(4)|ready(5)| decided(6)|suspended(7)}
A GET operation retrieves run-time information about the selected transactions. The following list describes the meaning of the tuxTQtransState object returned in response to a GET request. States not listed are not returned.
active(1)
The transaction is active.
abort-only(2)
The transaction has been identified for rollback.
aborted(3)
The transaction has been identified for rollback and rollback has been initiated.
com-called(4)
The initiator of the transaction has called tpcommit(3) and the first phase of two-phase commit has begun.
ready(5)
All of the participating groups on the retrieval site have successfully completed the first phase of the two-phase commit and are ready to be committed.
decided(6)
The second phase of the two-phase commit has begun.
suspended(7)
The initiator of the transaction has suspended processing on the transaction.
SET: {habort(8)|hcommit(9)}
A SET operation updates the state of the selected transactions. The following list describes the meaning of the tuxTQtransState object returned by a SET request. States not listed cannot be set.
habort(8)
Heuristically abort the transaction. Successful return leaves the object in the habort(8) state.
hcommit(9)
Heuristically commit the transaction. Successful return leaves the object in the hommit(9) state.

Copyright © 1994, 2017, Oracle and/or its affiliates. All rights reserved.