T_CLIENT CLASS

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

**T_CLIENT Class Definition Attribute Table**
Attribute¹	Type	Permissions	Values	Default
`TA_STATE( k )`	string	R-XR-XR--	GET:"{ACT\|SUS\|DEA}" SET:"{ACT\|SUS\|DEA}"	N/A
N/A
`TA_CLIENTID( * )` `TA_CLTNAME( k )` `TA_IDLETIME( k )` `TA_LMID( k )` `TA_PID( k )` `TA_SRVGRP( k )` `TA_USRNAME( k )` `TA_WSC( k )` `TA_WSH( k )` `TA_WSHCLIENTID( k )`	string string long string long string string string string string	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--	string[1...78] string[0...30] 0 <= num LMID 1 <= num string[0...30] string[0...30] "{Y\|N}" "{Y\|N}" string[1...78]	N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
`TA_RELEASE` `TA_WSPROTO`	long long	R--R--R-- R--R--R--	0 <= num 0 <= num	N/A N/A
`TA_NUMCONV` `TA_NUMDEQUEUE` `TA_NUMENQUEUE` `TA_NUMPOST` `TA_NUMREQ` `TA_NUMSUBSCRIBE` `TA_NUMTRAN` `TA_NUMTRANABT` `TA_NUMTRANCMT`	long long long long long long long long long	R-XR-XR-- R-XR-XR-- R-XR-XR-- R-XR-XR-- R-XR-XR-- R-XR-XR-- R-XR-XR-- R-XR-XR-- R-XR-XR--	0 <= num 0 <= num 0 <= num 0 <= num 0 <= num 0 <= num 0 <= num 0 <= num 0 <= num	N/A N/A N/A N/A N/A N/A N/A N/A N/A
`TA_CMTRET` `TA_CURCONV` `TA_CURENCRYPTBIT` `TA_CURREQ` `TA_CURTIME` `TA_LASTGRP` `TA_NADDR` `TA_NOTIFY` `TA_NUMUNSOL` `TA_RPID` `TA_TIMELEFT` `TA_TIMESTART` `TA_TRANLEV`	string long string long long long string string 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--R--R-- R--R--R-- R--R--R--	"{COMPLETE\|LOGGED}" 0 <= num { 0 \| 40 \| 128 } 0 <= num 1 <= num 1 <= num < < 30,000 string[1...78] "{DIPIN\|SIGNAL\|IGNORE}" 0 <= num 1 <= num 0 <= num 1 <= num 0 <= num	N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A
( k ) - `GET` key field ( * ) - `GET/SET` key, one or more required for `SET` operations

¹All attributes in Class T_CLIENT are local attributes.

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. States not listed will not be returned. 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 (3c) or tpacall (3c)) and from initiating further conversations ( tpconnect (3c)). 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 (3c) or tpacall (3c)), initiating conversations ( tpconnect (3c)), beginning transactions ( tpbegin (3c)), and enqueuing new requests ( tpenqueue (3c)). 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 (3c)), 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]

`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` (3c) or `tpacall` (3c)) and from initiating further conversations ( `tpconnect` (3c)). 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.

`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` (3c) or `tpacall` (3c)), initiating conversations ( `tpconnect` (3c)), beginning transactions ( `tpbegin` (3c)), and enqueuing new requests ( `tpenqueue` (3c)). 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` (3c)), 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.