[Top] [Prev] [Next] [Bottom]

T_APPQSPACE Class Definition

T_APPQSPACE Class Definition

Overview

The T_APPQSPACE class represents application queue spaces. An application queue space is an area in a BEA TUXEDO system device; see the T_DEVICE class in TM_MIB(5) for more information about devices and their attributes. Each queue space typically contains one or more application queues, and each queue may have messages stored in it.

A queue space is uniquely identified by several attributes: its name (TA_APPQSPACENAME attribute), the device that contains it (TA_QMCONFIG attribute), and the logical machine where the device is located (TA_LMID attribute).

A queue space is typically associated with exactly one server group in a configured application. The queue space name as well as the device name are components of the TA_OPENINFO attribute of the T_GROUP object.

Limitations

It is not possible to retrieve all instances of this class by leaving all key fields unset. Instead, all three key fields must be supplied to explicitly target a single application queue space. The single exception occurs when accessing a local queue space via tpadmcall(3) in the context of an unconfigured application (i.e., the TUXCONFIG environment variable is not set). In this case the TA_LMID key field must be omitted.

The above limitation regarding accessibility of queue spaces also applies to T_APPQ, T_APPQMSG, and T_APPQTRANS objects because operations on all objects in the /Q MIB implicitly involve queue spaces.

Attribute Table

APPQ_MIB(5): T_APPQSPACE Class Definition Attribute Table
Attributea Type Permissions Values Default

TA_APPQSPACENAME( k )( r )( * )

TA_QMCONFIG( k )( r )( * )

TA_LMID( k )( r )( * ))b

string

string

string

ru-r--r--

ru-r--r--

ru-r--r--

string[1..15]

string[1..78]

string[1..30]

N/A

N/A

N/A

TA_STATE( k )c

string

rwxrwxr--

GET:{INA|INI |OPE|ACT}

SET:{NEW|OPE |CLE|INV}

N/A

N/A

TA_BLOCKING

TA_ERRORQNAME

TA_FORCEINIT

TA_IPCKEY( r )

TA_MAXMSG( r )

TA_MAXPAGES( r )

TA_MAXPROC( r )

TA_MAXQUEUES( r )d

TA_MAXTRANS( r )

long

string

string

long

long

long

long

long

long

rw-r--r--

rw-r--r--

rw-r--r--

rw-r--r--

rw-r--r--

rw-r--r--

rw-r--r--

rw-r--r--

rw-r--r--

0 = num

string[0..15]

{Y|N}

32769 = num = 262143

0 = num

0 = num

0 = num

0 = num

0 = num

16

""

N

N/A

N/A

N/A

N/A

N/A

N/A

TA_CUREXTENT

TA_CURMSG

TA_CURPROC

TA_CURQUEUES

TA_CURTRANS

TA_HWMSG

TA_HWPROC

TA_HWQUEUES

TA_HWTRANS

TA_PERCENTINIT

long

long

long

long

long

long

long

long

long

long

r--r--r--

r--r--r--

r--r--r--

r--r--r--

R--R--R--

R--R--R--

R--R--R--

R--R--R--

R--R--R--

r--r--r--

0 = num = 100

{ 0 = num | -1 }

0 = num

{ 0 = num | -1 }

0 = num

0 = num

0 = num

0 = num

0 = num

0 = num = 100

N/A

N/A

N/A

N/A

N/A

N/A

N/A

N/A

N/A

N/A

( k ) - GET key field
( r ) - Required field for object creation
( * ) - Required SET key field

a. All attributes of class T_APPQSPACE 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_APPQ, T_APPQMSG, and T_APPQTRANS 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. TA_MAXQUEUES can not be modified after the queue space is created.

Attribute Semantics

TA_APPQSPACENAME: string[1..15]
Name of the application queue space.

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: {INActive|INItializing|OPEn|ACTive}
A GET operation retrieves information about the selected application queue space. 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.

INActive

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

Disk space for the queue space is currently being initialized. This state is ACTive equivalent for purposes of permissions checking.

OPEn

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

ACTive

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: {NEW|OPEn|CLEaning|INValid}
A SET operation changes the selected application queue space or creates a new one. 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 space. The state of the queue space becomes either INItializing or INActive following a successful SET to this state.

OPEn

Allocate and initialize shared memory and other IPC resources for the queue space. This is allowed only if the queue space is in the INActive state.

CLEaning

Remove the shared memory and other IPC resources for the queue space. This is allowed only when the queue space is in the OPEn or ACTive state. The QMIB_FORCECLOSE flag must be specified if the state is ACTive. Successful return leaves the object in the INActive state.

INValid

Delete the queue space. Unless the QMIB_FORCEDELETE flag is passed, an error is reported if the state is ACTive or if messages exist on any queues in the queue space. Successful return leaves the object in the INValid state.

unset

Modify an application queue space. Successful return leaves the state unchanged.

TA_BLOCKING: 0 = num
The blocking factor used for disk space management of the queue space. The default when a new queue space is created is 16.

TA_CUREXTENT: 0 = num = 100
The current number of extents used by the queue space. The largest number allowed is 100. Each time the TA_MAXPAGES attribute is increased, a new extent is allocated.

TA_CURMSG: 0 = num
The current number of messages in the queue space. This number can be determined only 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.

TA_CURPROC: 0 = num
The current number of processes accessing the queue space.

TA_CURQUEUES: 0 = num
The current number of queues existing in the queue space. This number can be determined only if the queue space is OPEn or ACTive, or if the queue space is newly created. If none of these conditions apply, the value -1 is returned.

TA_CURTRANS: 0 = num
The current number of outstanding transactions involving the queue space.

TA_ERRORQNAME: string[0..15]
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.

TA_FORCEINIT: {Y|N}
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.

TA_HWMSG: 0 = num
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.

TA_HWPROC: 0 = num
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.

TA_HWQUEUES: 0 = num
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.

TA_HWTRANS: 0 = num
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 \(em 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.

TA_IPCKEY: 32769 = num = 262143
The IPC key used to access queue space shared memory.

TA_MAXMSG: 0 = num
The maximum number of messages that the queue space can contain.

TA_MAXPAGES: 0 = num
The maximum number of disk pages for all queues in the queue space. Each time the TA_MAXPAGES attribute is increased, a new extent is allocated (see TA_CUREXTENT). It is not possible to decrease the number of pages by setting this attribute to a lower number; an error is reported in this case.

TA_MAXPROC: 0 = num
The maximum number of processes that can attach to the queue space.

TA_MAXQUEUES: 0 = num
The maximum number of queues that the queue space can contain.

TA_MAXTRANS: 0 = num
The maximum number of simultaneously active transactions allowed by the queue space.

TA_PERCENTINIT: 0 = num = 100
The percentage (as an integer between 0 and 100 inclusive) of disk space that has been initialized for the queue space.

[Top] [Prev] [Next] [Bottom]