PURPOSE
EVENT_MIB - TUXEDO Event Broker Management
Information Base
SYNOPSIS
#include <tpadm.h>
#include <fml32.h>
#include <evt_mib.h>
DESCRIPTION
The System/T Event Broker MIB defines the set of classes
through which the Event Broker can be managed.
EVENT_MIB(5) should
be used in combination with the generic MIB manual page, MIB(5), to format
administrative requests and interpret administrative replies.
Requests formatted as described in MIB(5) and a component MIB manual page may be
used to request an administrative service using any one of a
number of existing ATMI interfaces in an active application.
EVENT_MIB consists of the following classes:
| EVENT_MIB Classes |
| Class Name |
Attributes |
| T_EVENT_CLIENT |
Subscriptions that trigger unsolicited notification |
| T_EVENT_COMMAND |
Subscriptions that trigger system commands |
| T_EVENT_QUEUE |
Subscriptions for queue-based notification |
| T_EVENT_SERVICE |
Subscriptions for server-based notification |
| T_EVENT_USERLOG |
Subscriptions for writing userlog messages
|
Each object in these classes represents a single subscription
request.
FML32 FIELD TABLES
The field table for the attributes described in this manual
page is found in the file udataobj/evt_mib (relative
to the root directory of the TUXEDO System software). The
directory ${TUXDIR}/udataobj should be included by the
application in the colon-separated list specified by the FLDTBLDIR32
environment variable and the field table name evt_mib
should be included in the comma-separated list specified by the FIELDTBLS32
environment variable.
T_EVENT_CLIENT CLASS DEFINITION
Overview
The T_EVENT_CLIENT class represents a set of
subscriptions registered with the Event Broker 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, then the event buffer is
sent to the specified client's unsolicited message handling
routine.
Attribute Table
| EVENT_MIB(5): T_EVENT_CLIENT Class
Definition Attribute Table |
| Attribute |
Type |
Permissions |
Values |
Default |
| TA_EVENT_EXPR( r ) |
string |
R--R--R-- |
string[1...255] |
N/A |
| TA_EVENT_FILTER( k ) |
string |
R--R--R-- |
string[1...255] |
none |
| TA_EVENT_FILTER_BINARY( k ) |
carray |
R--R--R-- |
carray[1...64000] |
none |
| TA_STATE( r ) |
string |
R-xR-xR-x |
GET:"{ACT}" |
N/A |
| SET:"{NEW|INV}" |
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
Check MIB(5) for an
explanation of Permissions
Attribute Semantics
- TA_EVENT_EXPR: string[1...255]
- Event pattern expression. This expression, in recomp(3c)
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.
T_EVENT_COMMAND CLASS DEFINITION
Overview
The T_EVENT_COMMAND class represents a set of
subscriptions registered with the Event Broker that trigger
execution of system commands. When an event is detected, it is
compared to each T_EVENT_COMMAND object. If the event
name matches the value in TA_EVENT_EXPR and the
optional filter rule is true, then the event buffer is formatted
and passed to the system's command interpreter.
Attribute Table
| EVENT_MIB(5): T_EVENT_COMMAND Class
Definition Attribute Table |
| Attribute |
Type |
Permissions |
Values |
Default |
| TA_EVENT_EXPR( r ) |
string |
R-------- |
string[1...255] |
N/A |
| TA_EVENT_FILTER( k ) |
string |
R-------- |
string[1...255] |
none |
| TA_EVENT_FILTER_BINARY( k ) |
carray |
R-------- |
carray[1...64000] |
none |
| TA_STATE( r ) |
string |
R-x------ |
GET:"{ACT}" |
N/A |
| SET:"{NEW|INV}" |
N/A |
| TA_COMMAND( r ) |
string |
R-------- |
string[1...255] |
N/A |
( k ) - a key field for object retrieval
( r ) - the field is required when a new object is created
Check MIB(5) for an
explanation of Permissions
Attribute Semantics
- TA_EVENT_EXPR: string[1...255]
- Event pattern expression. This expression, in recomp(3c)
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_COMMAND
object(s).
- SET: {NEW|INValid}
- A SET operation will update
configuration information for the T_EVENT_COMMAND
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_COMMAND object.
Successful return leaves the object in
the ACTive state.
- INValid
- Delete T_EVENT_COMMAND object.
Successful return leaves the object in
the INValid state.
- TA_COMMAND: string[1...255]
- Execute this system command when an event matching this
object is detected. For UNIX System platforms, the
command is executed in the background using system(3).
T_EVENT_QUEUE CLASS DEFINITION
Overview
The T_EVENT_QUEUE class represents a set of
subscriptions registered with the Event Broker 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, then the event buffer is
stored in the specified reliable queue.
Attribute Table
| EVENT_MIB(5): T_EVENT_QUEUE Class
Definition Attribute Table |
| Attribute |
Type |
Permissions |
Values |
Default |
| TA_EVENT_EXPR( r ) |
string |
R-x------ |
string[1...255] |
N/A |
| TA_EVENT_FILTER( k ) |
string |
R-x------ |
string[1...255] |
none |
| TA_EVENT_FILTER_BINARY( k ) |
carray |
R-x------ |
carray[1...64000] |
none |
| TA_STATE( r ) |
string |
R-x------ |
GET:"{ACT}" |
N/A |
| SET:"{NEW|INV}" |
N/A |
| TA_QSPACE( r ) |
string |
R-x------ |
string[1...15] |
N/A |
| TA_QNAME( r ) |
string |
R-x------ |
string[1...15] |
N/A |
| TA_QCTL_QTOP |
short |
R-x------ |
short |
0 |
| TA_QCTL_BEFOREMSGID |
short |
R-x------ |
short |
0 |
| TA_QCTL_QTIME_ABS |
short |
R-x------ |
short |
0 |
| TA_QCTL_QTIME_REL |
short |
R-x------ |
short |
0 |
| TA_QCTL_DEQ_TIME |
long |
R-x------ |
long |
0 |
| TA_QCTL_PRIORITY |
short |
R-x------ |
short |
0 |
| TA_QCTL_MSGID |
string |
R-x------ |
string[1...31] |
none |
| TA_QCTL_CORRID( k ) |
string |
R-x------ |
string[1...31] |
none |
| TA_QCTL_REPLYQUEUE |
string |
R-x------ |
string[1...15] |
none |
| TA_QCTL_FAILUREQUEUE |
string |
R-x------ |
string[1...15] |
none |
| TA_EVENT_PERSIST |
short |
R-x------ |
short |
0 |
| TA_EVENT_TRAN |
short |
R-x------ |
short |
0 |
( k ) - a key field for object retrieval
( r ) - the field is required when a new object is created
Check MIB(5) for an
explanation of Permissions
Attribute Semantics
- TA_EVENT_EXPR: string[1...255]
- Event pattern expression. This expression, in recomp(3c)
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(3cbl)'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(3cbl)'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(3cbl)'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(3cbl)'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: long
- This value, if present, is passed in to tpenqueue(3cbl)'s
TPQCTL control structure.
- TA_QCTL_PRIORITY: short
- This value, if present, is passed in to tpenqueue(3cbl)'s
TPQCTL control structure.
- TA_QCTL_MSGID: string[1...31]
- This value, if present, is passed in to tpenqueue(3cbl)'s
TPQCTL structure.
- TA_QCTL_CORRID: string[1...31]
- This value, if present, is passed in to tpenqueue(3cbl)'s
TPQCTL control structure.
- TA_QCTL_REPLYQUEUE: string[1...15]
- This value, if present, is passed in to tpenqueue(3cbl)'s
TPQCTL control structure.
- TA_QCTL_FAILUREQUEUE: string[1...15]
- This value, if present, is passed in to tpenqueue(3cbl)'s
TPQCTL control structure.
- TA_EVENT_PERSIST: short
- If non-zero, do not cancel this subscription if the
designated queue is no longer available.
- TA_EVENT_TRAN: short
- If non-zero and the client's tppost(3c)
call is transactional, include the tpenqueue(3c)
call in the client's transaction.
T_EVENT_SERVICE CLASS DEFINITION
Overview
The T_EVENT_SERVICE class represents a set of
subscriptions registered with the Event Broker for service-based
notification. When an event is detected, it is compared to each T_EVENT_SERVICE
object. If the event name matches the value in TA_EVENT_EXPR
and the optional filter rule is true, then the event buffer is
sent to the specified TUXEDO service routine.
Attribute Table
| EVENT_MIB(5): T_EVENT_SERVICE Class
Definition Attribute Table |
| Attribute |
Type |
Permissions |
Values |
Default |
| TA_EVENT_EXPR( r ) |
string |
R--R--R-- |
string[1...255] |
N/A |
| TA_EVENT_FILTER( k ) |
string |
R--R--R-- |
string[1...255] |
none |
| TA_EVENT_FILTER_BINARY( k ) |
carray |
R--R--R-- |
carray[1...64000] |
none |
| TA_STATE( r ) |
string |
R-xR-xR-x |
GET:"{ACT}" |
N/A |
| SET:"{NEW|INV}" |
N/A |
| TA_SERVICENAME( r ) |
string |
R--R--R-- |
string[1...15] |
N/A |
| TA_EVENT_PERSIST |
short |
R-xR-xR-x |
short |
0 |
| TA_EVENT_TRAN |
short |
R-xR-xR-x |
short |
0 |
( k ) - a key field for object retrieval
( r ) - the field is required when a new object is created
Check MIB(5) for an
explanation of Permissions
Attribute Semantics
- TA_EVENT_EXPR: string[1...255]
- Event pattern expression. This expression, in recomp(3c)
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_SERVICE
object(s).
- SET: {NEW|INValid}
- A SET operation will update
configuration information for the T_EVENT_SERVICE
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_SERVICE object.
Successful return leaves the object in
the ACTive state.
- INValid
- Delete T_EVENT_SERVICE object.
Successful return leaves the object in
the INValid state.
- TA_SERVICENAME: string[1...15]
- Call this TUXEDO service when a matching event is
detected.
- TA_EVENT_PERSIST: short
- If non-zero, do not cancel this subscription if the TA_SERVICENAME
service is no longer available.
- TA_EVENT_TRAN: short
- If non-zero and the client's tppost(3c)
call is transactional, include the TA_SERVICENAME
service call in the client's transaction.
T_EVENT_USERLOG CLASS DEFINITION
Overview
The T_EVENT_USERLOG class represents a set of
subscriptions registered with the Event Broker for writing system
userlog(3c)
messages. When an event is detected, it is compared to each T_EVENT_USERLOG
object. If the event name matches the value in TA_EVENT_EXPR
and the optional filter rule is true, then the event buffer is
formatted and passed to TUXEDO's userlog(3c) function.
Attribute Table
| EVENT_MIB(5): T_EVENT_USERLOG Class
Definition Attribute Table |
| Attribute |
Type |
Permissions |
Values |
Default |
| TA_EVENT_EXPR( r ) |
string |
R--R----- |
string[1...255] |
N/A |
| TA_EVENT_FILTER( k ) |
string |
R--R----- |
string[1...255] |
none |
| TA_EVENT_FILTER_BINARY( k ) |
carray |
R--R----- |
carray[1...64000] |
none |
| TA_STATE( r ) |
string |
R-xR-x--- |
GET:"{ACT}" |
N/A |
| SET:"{NEW|INV}" |
N/A |
| TA_USERLOG( r ) |
string |
R--R----- |
string[1...255] |
N/A |
( k ) - a key field for object retrieval
( r ) - the field is required when a new object is created
Check MIB(5) for an
explanation of Permissions
Attribute Semantics
- TA_EVENT_EXPR: string[1...255]
- Event pattern expression. This expression, in recomp(3c)
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_USERLOG
object(s).
- SET: {NEW|INValid}
- A SET operation will update
configuration information for the T_EVENT_USERLOG
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_USERLOG object.
Successful return leaves the object in
the ACTive state.
- INValid
- Delete T_EVENT_USERLOG object.
Successful return leaves the object in
the INValid state.
- TA_USERLOG: string[1...255]
- Write a userlog(3c)
message when a matching event is detected.
FILES
${TUXDIR}/udataobj/evt_mib
${TUXDIR}/include/evt_mib.h
SEE ALSO
EVENTS(5), TM_MIB(5)