Section 5 - File Formats, Data Descriptions, MIBs, and System Processes Reference

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

T_EVENT_CLIENT Class Definition

Overview

The T_EVENT_CLIENT class represents a set of subscriptions registered with the EventBroker for client-based notification.

When an event is detected, it is compared to each T_EVENT_CLIENT object. If the event name matches the value in TA_EVENT_EXPR and the optional filter rule is TRUE, the event buffer is sent to the specified client's unsolicited message handling routine.

Attribute Table

Table 31 T_EVENT_CLIENT Class Definition Attribute Table

Attribute	Type	Permissions	Values	Default
`TA_EVENT_EXPR`(r) (*) `TA_EVENT_FILTER`(k) `TA_EVENT_FILTER_BINARY`(k)	string string carray	`R--R--R--` `R--R--R--` `R--R--R--`	`string`[1..255] `string`[1..255] `carray`[1..64000]	N/A none none
`TA_STATE`(r)	string	`R-xR-xR-x`	`GET`: `ACT` `SET`: {`NEW` \| `INV`}	N/A N/A
`TA_CLIENTID`(r) (*)	string	`R--R--R--`	`string`[1..78]	N/A
(k)—a key field for object retrieval (r)—the field is required when a new object is created (*)—`GET/SET` key, one or more required for `SET` operations

Check MIB(5) for an explanation of Permissions.

Attribute Semantics

TA_EVENT_EXPR: string[1..255]

Event pattern expression. This expression, in regular expression format, controls which event names match this subscription.

TA_EVENT_FILTER: string[1..255]

Event filter expression. This expression, if present, is evaluated with respect to the posted buffer's contents. It must evaluate to TRUE or this subscription is not matched.

TA_EVENT_FILTER_BINARY: carray[1..64000]

Event filter expression, in binary (carray) format. Same as TA_EVENT_FILTER, but may contain arbitrary binary data. Only one of TA_EVENT_FILTER or TA_EVENT_FILTER_BINARY may be specified.

TA_STATE:

GET: ACTive

A GET operation will retrieve configuration information for the matching T_EVENT_CLIENT object(s).

SET: {NEW | INValid}

A SET operation will update configuration information for the T_EVENT_CLIENT object. The following states indicate the meaning of a TA_STATE set in a SET request. States not listed may not be set.

`NEW`	Create `T_EVENT_CLIENT` object. Successful return leaves the object in the `ACTive` state.
`INValid`	Delete `T_EVENT_CLIENT` object. Successful return leaves the object in the `INValid` state.

TA_CLIENTID: string[1..78]

Send an unsolicited notification message to this client when a matching event is detected.