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

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

T_EVENT_QUEUE Class Definition

Overview

The T_EVENT_QUEUE class represents a set of subscriptions registered with the EventBroker for queue-based notification. When an event is detected, it is compared to each T_EVENT_QUEUE object. If the event name matches the value in TA_EVENT_EXPR and the optional filter rule is TRUE, the event buffer is stored in the specified reliable queue.

Attribute Table

Table 33 T_EVENT_QUEUE 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-x------` `R-x------`	`string`[1..255] `string`[1..255] `carray`[1..64000]	N/A none none
`TA_STATE`(r)	string	`R-x------`	`GET`: `ACT` `SET`: {`NEW` \| `INV`}	N/A N/A
`TA_QSPACE`(r) () `TA_QNAME`(r) () `TA_QCTL_QTOP` `TA_QCTL_BEFOREMSGID` `TA_QCTL_QTIME_ABS` `TA_QCTL_QTIME_REL` `TA_QCTL_DEQ_TIME` `TA_QCTL_PRIORITY` `TA_QCTL_MSGID` `TA_QCTL_CORRID`(k) `TA_QCTL_REPLYQUEUE` `TA_QCTL_FAILUREQUEUE`	string string short short short short short short string string string string	`R--------` `R--------` `R-x------` `R-x------` `R-x------` `R-x------` `R-x------` `R-x------` `R-x------` `R-x------` `R-x------` `R-x------`	`string`[1..15] `string`[1..15] `short` `short` `short` `short` `short` `short` `string`[1..31] `string`[1..31] `string`[1..15] `string`[1..15]	N/A N/A 0 0 0 0 0 0 none none none none
`TA_EVENT_PERSIST` `TA_EVENT_TRAN`	short short	`R-x------` `R-x------`	`short` `short`	0 0
(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

Attribute

Type

Permissions

Values

Default

TA_EVENT_EXPR(r) (*)

TA_EVENT_FILTER(k)

TA_EVENT_FILTER_BINARY(k)

string

carray

R--------

R-x------

string[1..255]

carray[1..64000]

N/A

none

TA_STATE(r)

string

R-x------

GET: ACT

SET: {NEW | INV}

N/A

TA_QSPACE(r) (*)

TA_QNAME(r) (*)

TA_QCTL_QTOP

TA_QCTL_BEFOREMSGID

TA_QCTL_QTIME_ABS

TA_QCTL_QTIME_REL

TA_QCTL_DEQ_TIME

TA_QCTL_PRIORITY

TA_QCTL_MSGID

TA_QCTL_CORRID(k)

TA_QCTL_REPLYQUEUE

TA_QCTL_FAILUREQUEUE

string

short

string

R--------

R-x------

string[1..15]

short

string[1..31]

string[1..15]

N/A

none

TA_EVENT_PERSIST

TA_EVENT_TRAN

short

R-x------

short

(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_QUEUE object(s).

SET: {NEW | INValid}

A SET operation will update configuration information for the T_EVENT_QUEUE 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_QUEUE` object. Successful return leaves the object in the `ACTive` state.
`INValid`	Delete `T_EVENT_QUEUE` object. Successful return leaves the object in the `INValid` state.

TA_QSPACE: string[1..15]

Enqueue a notification message to a reliable queue in this queue space when a matching event is detected.

TA_QNAME: string[1..15]

Enqueue a notification message to this reliable queue when a matching event is detected.

TA_QCTL_QTOP: short

This value, if present, is passed in to tpenqueue()'s TPQCTL control structure to request notification via the /Q subsystem with the message to be placed at the top of the queue.

TA_QCTL_BEFOREMSGID: short

This value, if present, is passed in to tpenqueue()'s TPQCTL control structure to request notification via the /Q subsystem with the message to be placed on the queue ahead of the specified message.

TA_QCTL_QTIME_ABS: short

This value, if present, is passed in to tpenqueue()'s TPQCTL control structure to request notification via the /Q subsystem with the message to be processed at the specified time.

TA_QCTL_QTIME_REL: short

This value, if present, is passed in to tpenqueue()'s TPQCTL control structure to request notification via the /Q subsystem with the message to be processed relative to the dequeue time.

TA_QCTL_DEQ_TIME: short