Table of Contents Previous Next PDF


EventBroker MIB

EventBroker MIB
There are two types of Oracle Tuxedo events: application events and system events. Application events are usually controlled or trapped by the application code. System events are generated by the Tuxedo run-time system when important changes in that system are detected. Application programs (clients or services) can subscribe to these system events.
The EventBroker MIB defines the characteristics of an event subscription. You can use the EventBroker MIB to obtain the characteristics of current event subscriptions, define new subscriptions, or invalidate subscriptions. To enable both system event and application event notification, you need to define the system event broker and the application event broker in the Core MIB.
Event subscriptions can be temporary or persistent. Persistent subscriptions survive across application activations and can be removed through the EventBroker MIB. The Tuxedo EventBroker MIB contains five groups of event subscriptions through which the EventBroker can be managed.
The EventBroker MIB consists of the following subscription groups.
 
Each object in these groups represents a single subscription request. Client Notifications (tuxEventClientTbl group) indicate which events trigger an unsolicited message to a client. Service Notifications (tuxEventSvcTbl group) indicate which events trigger a request to an application service. Application Queue Notifications (tuxEventQueTbl group) indicate which events send a message to an application queue. System Command Notifications (tuxEventCmdTbl group) indicate which events trigger an operating system command. Log File Notifications (tuxEventUlogTbl group) indicate which events generate a record in the central event log (ulog). The EventBroker automatically removes temporary subscriptions when it detects that the corresponding target is no longer active.
Event subscriptions and the ability to change the Tuxedo MIB enables system administrators and application designers to write event-adaptive applications. When a failure is detected through a system event notification, a management framework program can perform the corrective measures. For example, a management framework task can be triggered to activate servers on a backup machine when it receives an event notification about a failure on a primary machine.
tuxEventClientTbl
This group contains objects that represent subscriptions registered with the EventBroker for client-based notification.
When an event is detected, it is compared to each tuxEventClientTbl instance. If the event name matches the value in the event expression and the optional filter rule is true, then the event buffer is sent to the specified client’s unsolicited message handling routine. To create a new row in this table, it is necessary to issue a SET request that at least specifies the values for tuxEventClientExpr and tuxEventClientId.
 
tuxEventClientIndx
Syntax
INTEGER
Access
read-only
Description
A running number as the unique identifier for a row in the table.
tuxEventClientExpr
Syntax
DisplayString (SIZE(1..255))
Access
read-only
Description
Event pattern expression. This expression, which is a regular expression, controls which event names match this subscription. For the format of regular expressions, see reference page tpsubscribe(3c) in Oracle Tuxedo ATMI C Function Reference.
Note:
tuxEventClientFilter
Syntax
DisplayString (SIZE(1..255))
Access
read-only
Description
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. If the value of this is “-”, it means that the filter expression is in binary format.
Note:
tuxEventClientState
Syntax
INTEGER { active(1), invalid(2) }
Access
read-write
Description
The values for GET and SET operations are as follows:
GET: active(1)
A GET operation retrieves configuration information for the matching tuxEventClientTbl row(s).
SET: invalid(2)
A SET operation updates configuration information for the row in tuxEventClientTbl. The following state indicates the meaning of a tuxEventClientState set in a SET request. States not listed cannot be set.
invalid(2)
Delete row. Successful return leaves the row in the invalid(2) state.
tuxEventClientId
Syntax
DisplayString (SIZE(1..78))
Access
read-only
Description
Send an unsolicited notification message to this client when a matching event is detected.
Note:
tuxEventCmdTbl
This group contains objects that represent subscriptions registered with the EventBroker that trigger execution of system commands.
When an event is detected, it is compared to each row in this table. If the event name matches the value in the event expression and the optional filter rule is true, then the event buffer is formatted and passed to the system’s command interpreter.
Create a new Row: To create a new instance of tuxEventCmdTbl the user must specify at least tuxEventCmdExpr and tuxEventCmd. All objects except tuxEventCmdState can be updated only during creation of a new instance.
 
tuxEventCmdIndx
Syntax
INTEGER
Access
read-only
Description
A running number as the unique identifier for a row in the table.
tuxEventCmdExpr
Syntax
DisplayString (SIZE(1..255))
Access
read-write
Description
Event pattern expression. This expression, which is a regular expression, controls which event names match this subscription. For the format of regular expressions, see reference page tpsubscribe(3c) in Oracle Tuxedo ATMI C Function Reference.
Note:
tuxEventCmdFilter
Syntax
DisplayString (SIZE(1..255))
Access
read-write
Description
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. If the value of the filter is “-”, it means that the filter is in a binary format.
Note:
tuxEventCmdState
Syntax
INTEGER { active(1), invalid(2) }
Access
read-write
Description
The values for GET and SET operations are as follows:
GET: active(1)
A GET operation retrieves configuration information for the tuxEventCmdTbl instance(s).
SET: invalid(2)
A SET operation updates configuration information for the tuxEventCmdTbl instance. The following state indicates the meaning of a tuxEventCmdState set in a SET request. States not listed cannot be set.
invalid(2)
Delete tuxEventCmdTbl instance. Successful return leaves the object in the invalid(2) state.
tuxEventCmd
Syntax
DisplayString (SIZE(1..255))
Access
read-write
Description
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).
Note:
tuxEventQueTbl
This group contains objects that represent subscriptions registered with the EventBroker for queue-based notification.
When an event is detected, it is compared to each tuxEventQueTbl instance. If the event name matches the value in the event expression and the optional filter rule is true, then the event buffer is stored in the specified reliable queue. To create a new row in this table, it is necessary to issue a SET request that at least specifies tuxEventQueExpr, tuxEventQspace, and tuxEventQname.
 
tuxEventQueIndx
Syntax
INTEGER
Access
read-only
Description
Running number which is the unique identifier for an event in this table.
tuxEventQueExpr
Syntax
DisplayString (SIZE(1..255))
Access
read-write
Description
Event pattern expression. This expression, which is a regular expression, controls which event names match this subscription. For the format of regular expressions, see reference page tpsubscribe(3c) in Oracle Tuxedo ATMI C Function Reference.
Note:
tuxEventQueFilter
Syntax
DisplayString (SIZE(1..255))
Access
read-write
Description
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. If the value of this object is “-”, it means the filter is in binary format.
Note:
tuxEventQueState
Syntax
INTEGER { active(1), invalid(2) }
Access
read-write
Description
The values for GET and SET operations are as follows:
GET: active(1)
A GET operation retrieves configuration information for the matching tuxEventQueTbl row(s).
SET: invalid(2)
A SET operation updates configuration information for the tuxEventQueTbl instance. The following state indicates the meaning of a tuxEventQueState set in a SET request. States not listed cannot be set.
invalid(2)
Delete tuxEventQueTbl row. Successful return leaves the object in the invalid(2) state.
tuxEventQspace
Syntax
DisplayString (SIZE(1..127))
Access
read-write
Description
Enqueue a notification message to a reliable queue in this queue space when a matching event is detected.
Note:
tuxEventQname
Syntax
DisplayString (SIZE(1..127))
Access
read-write
Description
Enqueue a notification message to this reliable queue when a matching event is detected.
Note:
tuxEventQctlQtop
Syntax
INTEGER
Access
read-write
Description
This value, if present, is passed in to tpenqueue(3)’s TPQCTL control structure to request notification via the /Q subsystem with the message to be placed at the top of the queue.
Note:
tuxEventQctlBeforeMsgid
Syntax
INTEGER
Access
read-write
Description
This value, if present, is passed in to tpenqueue(3)’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.
Note:
tuxEventQctlQtimeAbs
Syntax
INTEGER
Access
read-write
Description
This value, if present, is passed in to tpenqueue(3)’s TPQCTL control structure to request notification via the /Q subsystem with the message to be processed at the specified time.
Note:
tuxEventQctlQtimeRel
Syntax
INTEGER
Access
read-write
Description
This value, if present, is passed in to tpenqueue(3)’s TPQCTL control structure to request notification via the /Q subsystem with the message to be processed relative to the dequeue time.
Note:
tuxEventQctlDeqTime
Syntax
INTEGER
Access
read-write
Description
This value, if present, is passed in to tpenqueue(3)’s TPQCTL control structure.
Note:
tuxEventQctlPrior
Syntax
INTEGER
Access
read-write
Description
This value, if present, is passed in to tpenqueue(3)’s TPQCTL control structure.
Note:
tuxEventQctlMsgId
Syntax
DisplayString (SIZE(1..31))
Access
read-write
Description
This value, if present, is passed in to tpenqueue(3)’s TPQCTL control structure.
Note:
tuxEventQctlCorrId
Syntax
DisplayString (SIZE(1..31))
Access
read-write
Description
This value, if present, is passed in to tpenqueue(3)’s TPQCTL control structure.
Note:
tuxEventQctlReplyQ
Syntax
DisplayString (SIZE(1..127))
Access
read-write
Description
This value, if present, is passed in to tpenqueue(3)’s TPQCTL control structure.
Note:
tuxEventQctlFailQ
Syntax
DisplayString (SIZE(1..127))
Access
read-write
Description
This value, if present, is passed in to tpenqueue(3)’s TPQCTL control structure.
Note:
tuxEventPersist
Syntax
INTEGER
Access
read-write
Description
If non-zero, do not cancel this subscription if the designated queue is no longer available.
Note:
tuxEventTran
Syntax
INTEGER
Access
read-write
Description
If non-zero and the client’s tppost(3) call is transactional, include the tpenqueue(3) call in the client’s transaction.
Note:
tuxEventSvcTbl
This group contains objects that represent subscriptions registered with the EventBroker for service-based notification.
When an event is detected, it is compared to each tuxEventSvcTbl instance. If the event name matches the value in the event expression and the optional filter rule is true, then the event buffer is sent to the specified Tuxedo service routine.
To create a new row in this table, a SET request must be issued that specifies values for at least tuxEventSvcExpr and tuxEventSvcName.
.
tuxEventSvcIndx
Syntax
INTEGER
Access
read-only
Description
A running number which is a unique key for a row in this table.
tuxEventSvcExpr
Syntax
DisplayString (SIZE(1..255))
Access
read-only
Description
Event pattern expression. This expression, which is a regular expression, controls which event names match this subscription. For the format of regular expressions, see reference page tpsubscribe(3c) in Oracle Tuxedo ATMI C Function Reference.
Note:
tuxEventSvcFilter
Syntax
DisplayString (SIZE(1..255))
Access
read-only
Description
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. If this is “-”, it means the filter is in binary format.
Note:
tuxEventSvcState
Syntax
INTEGER { active(1), invalid(2) }
Access
read-write
Description
The values for GET and SET operations are as follows:
GET: active(1)
A GET operation retrieves configuration information for the matching tuxEventSvcTbl instance(s).
SET: invalid(2)
A SET operation updates configuration information for the tuxEventSvcTbl instance. The following state indicates the meaning of a tuxEventSvcState set in a SET request. States not listed cannot be set.
invalid(2)
Delete tuxEventSvcTbl row. Successful return leaves the object in the invalid(2) state.
tuxEventSvcName
Syntax
DisplayString (SIZE(1..127))
Access
read-only
Description
Call this Tuxedo service when a matching event is detected.
Note:
tuxEventSvcPersist
Syntax
INTEGER
Access
read-write
Description
If non-zero, do not cancel this subscription if the tuxEventSvcName service is no longer available.
Note:
tuxEventSvcTran
Syntax
INTEGER
Access
read-write
Description
If non-zero and the client’s tppost(3) call is transactional, include the tuxEventSvcName service call in the client’s transaction.
Note:
tuxEventUlogTbl
This group contains objects that represent subscriptions registered with the EventBroker for writing system userlog(3) messages.
When an event is detected, it is compared to each tuxEventUlogTbl instance. If the event name matches the value in the event expression and the optional filter rule is true, then the event buffer is formatted and passed to the Tuxedo userlog(3) function.
Create a new Row: To create a new instance of tuxEventUlogTbl the user must at least specify values for tuxEventUlogExpr and tuxEventUserlog. All objects except tuxEventUlogState can be updated only during creation of a new instance.
 
tuxEventUlogIndx
Syntax
INTEGER
Access
read-only
Description
A running number which is a unique key in this table.
tuxEventUlogExpr
Syntax
DisplayString (SIZE(1..255))
Access
read-write
Description
Event pattern expression. This expression, which is a regular expression, controls which event names match this subscription. For the format of regular expressions, see reference page tpsubscribe(3c) in Oracle Tuxedo ATMI C Function Reference.
Note:
tuxEventUlogFilter
Syntax
DisplayString (SIZE(1..255))
Access
read-write
Description
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. If this is “-”, it means the filter is in binary form.
Note:
tuxEventUlogState
Syntax
INTEGER { active(1), invalid(2) }
Access
read-write
Description
The values for GET and SET operations are as follows:
GET: active(1)
A GET operation retrieves configuration information for the matching tuxEventUlogTbl instance(s).
SET: invalid(2)
A SET operation updates configuration information for the tuxEventUlogTbl instance. The following state indicates the meaning of a tuxEventUlogState set in a SET request. States not listed cannot be set.
invalid(2)
Delete tuxEventUlogTbl row. Successful return leaves the object in the invalid(2) state.
tuxEventUserlog
Syntax
DisplayString (SIZE(1..255))
Access
read-write
Description
Write a userlog(3) message when a matching event is detected.
Note:

Copyright © 1994, 2017, Oracle and/or its affiliates. All rights reserved.