File Formats, Data Descriptions, MIBs, and System Processes Reference

 

---

T_CLIENT Class Definition

Overview

The T_CLIENT class represents run-time attributes of active clients within an application. These attribute values identify and track the activity of clients within a running application.

Attribute Table

  ¹ All attributes in the T_CLIENT class are local attributes.
² Link-level encryption value of 40 bits is provided for backward compatibility.
³ Maximum string length for this attribute is 78 bytes for BEA Tuxedo 8.0 or earlier.

Attribute Semantics

TA_STATE:

GET: "{ACTive | SUSpended | DEAd}"

A GET operation will retrieve run-time information for the selected T_CLIENT object(s). Note that client information is kept in local bulletin board tables only. Therefore, for maximum performance, inquiries on client status should be restricted using key fields as much as possible. The following states indicate the meaning of a TA_STATE returned in response to a GET request.

ACTive	T_CLIENT object active. This is not an indication of whether the client is idle or busy. A non 0 value retrieved for either the TA_CURCONV attribute or the TA_CURREQ attribute indicates a busy client.
SUSpended	T_CLIENT object active and suspended from making further service requests (tpcall() or tpacall()) and from initiating further conversations (tpconnect()). See SET SUSpended below for details. This state is ACTive equivalent for the purpose of determining permissions.
DEAd	T_CLIENT object identified as active in the bulletin board but currently not running due to an abnormal death. This state will exist only until the BBL local to the client notices the death and takes action to clean up the client's bulletin board resources. This state is ACTive equivalent for the purpose of determining permissions.

 

SET: "{ACTive | SUSpended | DEAd}"

A SET operation will update run-time information for the selected T_CLIENT object. The following states indicate the meaning of a TA_STATE set in a SET request. States not listed may not be set.

ACTive	Activate a SUSpended T_CLIENT object. State change allowed only when in the SUSpended state. Successful return leaves the object in the ACTive state.
unset	Modify an existing T_CLIENT object. This combination is allowed only when in the ACTive or SUSpended state. Successful return leaves the object state unchanged.
SUSpended	Suspend the T_CLIENT object from making service requests (tpcall() or tpacall()), initiating conversations (tpconnect()), beginning transactions (tpbegin()), and enqueuing new requests (tpenqueue()). Clients within a transaction will be permitted to make these calls until they abort or commit the current transaction, at which time they will become suspended. Invocations of these routines will result in a TPESYSTEM error return and a system log message being generated indicating the situation. State change allowed only when in the ACTive state. Successful return leaves the object in the SUSpended state.
DEAd	Abortively deactivate the T_CLIENT object. State change allowed only when in the ACTive or SUSpended state. The recommended method for deactivating clients is to first broadcast a warning message (tpbroadcast)), then to suspend them (see SET SUSpended above), and finally to abortively deactivate them by setting the state to DEAd. Successful return leaves the object in the DEAd state. Limitation: Workstation handlers (T_CLIENT:TA_WSH == Y) may not be set to a state of DEAd. The system may not be able to kill the client due to platform or signaling restrictions. In this case, a native client will be abortively terminated at its next access to ATMI, and a Workstation client's connection to a WSH will be preemptively torn down.

 

TA_CLIENTID: string[1..78]

Client identifier. The data in this field should not be interpreted directly by the end user except for equality comparison.

TA_CLTNAME: string[0..30]

Client name associated with client at tpinit() time via the cltname element of the TPINIT structure.

TA_IDLETIME: 0 <= num

Approximate amount of time, in seconds, since this client last interacted with the system via an ATMI call. This value is accurate to within TA_SCANUNIT (see the T_DOMAIN class) seconds. When specified as a key field, a positive value indicates that all clients with idle times of at least the indicated value match, a negative value indicates that all clients with no more than the indicated value match, and a 0 value matches all clients.

TA_TPBLK_ALL: 0 <= num

Reports the current tpsblktime(TPBLK_ALL)blocktime value per client. If TPBLK_ALL has not been set, then the TA_TPBLK_ALL value is 0.

TA_LMID: LMID

Logical machine where client is running (native clients) or where client is connected (Workstation clients).

TA_PID: 1 <= num

Process identifier of client. Note that for Workstation clients, this identifier indicates the workstation handler through which the Workstation client is connected. A negative number may be specified on a GET operation for the purpose of retrieving client information for the calling process. If the calling process is not a client, an error will be returned.

TA_CONTEXTID: -2 <= num < 30,000

Identifier for this particular application association.

TA_SRVGRP: string[0..30]

Server group with which the client is associated. This information is set via the grpname element of the TPINIT structure at tpinit() time.

TA_USRNAME: string[0..30]

User name associated with client at tpinit() time via the usrname element of the TPINIT structure.

TA_WSC: "{Y | N}"

Workstation client. If this attribute is set to "Y", the indicated client is logged in to the application from a remote workstation.

TA_WSH: "{Y | N}"

Workstation handler. If this attribute is set to "Y", the indicated client is a workstation handler process.

TA_WSHCLIENTID: string[1..78]

Client identifier for the associated workstation handler (WSH) if this client is a Workstation client (TA_WSH == Y); otherwise, this attribute will be returned as a 0-length string.

TA_RELEASE: 0 <= num

The BEA Tuxedo system major protocol release number for the machine where the client is running. This may be different from the TA_SWRELEASE for the same machine. Note that for Workstation clients (TA_WSC == Y), this value may be different than the major release associated with the application administered machine through which the Workstation client accesses the application.

TA_WSPROTO: 0 <= num

The BEA Tuxedo system Workstation protocol version number for a Workstation client. This value is changed with each update to the Workstation protocol. A value of 0 is returned for this attribute when associated with non-Workstation clients (TA_WSC == N).

TA_NUMCONV: 0 <= num

Number of conversations initiated by this client via tpconnect().

TA_NUMDEQUEUE: 0 <= num

Number of dequeue operations initiated by this client via tpdequeue().

TA_NUMENQUEUE: 0 <= num

Number of enqueue operations initiated by this client via tpenqueue().

TA_NUMPOST: 0 <= num

Number of postings initiated by this client via tppost().

TA_NUMREQ: 0 <= num

Number of requests made by this client via tpcall() or tpacall().

TA_NUMSUBSCRIBE: 0 <= num

Number of subscriptions made by this client via tpsubscribe().

TA_NUMTRAN: 0 <= num

Number of transactions begun by this client.

TA_NUMTRANABT: 0 <= num

Number of transactions aborted by this client.

TA_NUMTRANCMT: 0 <= num

Number of transactions committed by this client.

TA_CMTRET: "{COMPLETE | LOGGED}"

Setting of the TP_COMMIT_CONTROL characteristic for this client. See the description of the BEA Tuxedo System ATMI function tpscmt() for details on this characteristic.

TA_CURCONV: 0 <= num

Number of conversations initiated by this client via tpconnect() that are still active.

TA_CURENCRYPTBITS: "{0 | 40 | 56 | 128}"

The current encryption level for this client. The level is negotiated when the link is established.

Note: The link-level encryption value of 40 bits is provided for backward compatibility.

TA_CURREQ: 0 <= num

Number of requests initiated by this client via tpcall() or tpacall() that are still active.

TA_CURTIME: 1 <= num

Current time, in seconds, since 00:00:00 UTC, January 1, 1970, as returned by the time(2) system call on T_CLIENT:TA_LMID. This attribute can be used to compute elapsed time from the T_CLIENT:TA_TIMESTART attribute value.

TA_LASTGRP: 1 <= num < 30,000

Server group number (T_GROUP:TA_GRPNO) of the last service request made or conversation initiated from this client.

TA_NADDR: string[1..256] (up to 78 bytes for BEA Tuxedo 8.0 or earlier)

For Workstation clients, this attribute indicates the network address of the client. Network addresses with unprintable characters are converted to one of the following formats:

• "0xhex-digits"
• "\\xhex-digits"

A string in either format must contain an even number of valid hex digits. Such a string is translated internally into a character array containing the hexadecimal representations of the string specified.

For TCP/IP addresses one of the following formats is used:

• "//hostname:port"
• "//#.#.#.#:port_number"

Each # (pound) sign represents a decimal number in the range of 0 to 255. The value of port_number is a decimal number in the range of 0 to 65535.

Note: Some port numbers may be reserved for the underlying transport protocols (such as TCP/IP) used by your system. Check the documentation for your transport protocols to find out which numbers, if any, are reserved on your system.

Non-Workstation clients have a 0-length string associated with them for this attribute value.

Limitation: The ability of the system to provide this information is determined by the transport provider in use. In some cases, Workstation clients may not have addresses associated with them if the provider does not make this information available.

TA_NOTIFY: "{DIPIN | SIGNAL | THREAD | IGNORE}"

Setting of the notification characteristic for this client. See the T_DOMAIN class description of this attribute for more details.

TA_NUMUNSOL: 0 <= num

Number of unsolicited messages queued for this client awaiting processing.

TA_RPID: 1 <= num

UNIX system message queue identifier for the client's reply queue. Limitation: This is a UNIX system specific attribute that may not be returned if the platform on which the application is being run is not UNIX-based.

TA_TIMELEFT: 0 <= num

Time left, in seconds, for this client to receive the reply for which it is currently waiting before it will timeout. This time out may be a transactional timeout or a blocking timeout.

TA_TIMESTART: 1 <= num

Time, in seconds, since 00:00:00 UTC, January 1, 1970, as returned by the time(2) system call on T_CLIENT:TA_LMID, since the client joined the application.

TA_TRANLEV: 0 <= num

Current transaction level for this client. 0 indicates that the client is not currently involved in a transaction.

Limitations

None.

Contact BEA |  Feedback |  Privacy  |