Event manager domain’s specific gates

Table 53 summarizes the event manager domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gate, the functions provided by the gate, and whether or not the functions are available through the exit programming interface (XPI).

Table 53. Event manager domain’s specific gates
Gate Trace Function XPI
EMEM
EM 0201
EM 0202
ADD_SUBEVENT
CHECK_TIMER
DEFINE_ATOMIC_EVENT
DEFINE_COMPOSITE_EVENT
DEFINE_TIMER

DELETE_EVENT
DELETE_TIMER
FIRE_EVENT
FORCE_TIMER
INQUIRE_STATUS
REMOVE_SUBEVENT
RESET_EVENT
RETRIEVE_REATTACH_EVENT
RETRIEVE_SUBEVENT
TEST_EVENT
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
EMBR
EM 0301
EM 0302
INQUIRE_EVENT
START_BROWSE_EVENT
GET_NEXT_EVENT
END_BROWSE_EVENT
INQUIRE_TIMER
START_BROWSE_TIMER
GET_NEXT_TIMER
END_BROWSE_TIMER
NO
NO
NO
NO
NO
NO
NO
NO

EMEM gate, ADD_SUBEVENT function

The ADD_SUBEVENT function adds a subevent to an existing composite event.

Input parameters

EVENT
is the name of the composite event.
SUBEVENT
is the name of the subevent.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
EVENT_NOT_FOUND
INVALID_EVENT_TYPE
SUBEVENT_NOT_FOUND
INVALID_SUBEVENT

EMEM gate, CHECK_TIMER function

The CHECK_TIMER function returns the status of a timer.

Input parameters

TIMER_NAME
is the name of the timer.

Output parameters

TIMER_STATUS
returns the status of the timer. It can have one of these values:
EXPIRED|FORCED|UNEXPIRED
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
TIMER_NOT_FOUND

EMEM gate, DEFINE_ATOMIC_EVENT function

The DEFINE_ATOMIC_EVENT function defines an atomic event of type ACTIVITY or INPUT.

Input parameters

EVENT
is the name of the event.
EVENT_TYPE
is the type of the event. It can have one of these values:
ACTIVITY|INPUT

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
INVALID_EVENT_NAME
DUPLICATE_EVENT

EMEM gate, DEFINE_COMPOSITE_EVENT function

The DEFINE_COMPOSITE_EVENT function defines a composite event with an associated predicate which may be AND or OR. Up to eight subevents may be provided.

Input parameters

EVENT
is the name of the composite event.
PREDICATE
is the predicate type. It may have either one of these values:
AND|OR
SUBEVENT_LIST
is an optional list of up to 8 subevents.

Output parameters

SUBEVENT_IN_ERROR
returns the number of the first subevent which is in error (if any).
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
INVALID_EVENT_NAME
SUBEVENT_NOT_FOUND
INVALID_SUBEVENT
DUPLICATE_EVENT

EMEM gate, DEFINE_TIMER function

The DEFINE_TIMER function defines a timer.

Input parameters

TIMER_NAME
is the name of the timer.
EVENT
is the optional name of an event to be associated with the timer.
AFTER
indicates whether or not the timer is an interval. It may have either of these values:
YES|NO
AT
indicates whether or not the timer is a time. It may have either of these values:
YES|NO
DAYS
is the number of days for an interval.
HOURS
is the number of hours for an interval or time.
MINUTES
is the number of minutes for an interval or time.
SECONDS
is the number of seconds for an interval or time.
ON
indicates whether or not a date has been specified. It may have either of these values:
YES|NO
YEAR
is the year.
MONTH
is the month.
DAYOFMONTH
is the day of the month.
DAYOFYEAR
is the day of the year.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
INVALID_TIMER_NAME
DUPLICATE_TIMER
INVALID_EVENT_NAME
DUPLICATE_EVENT
INVALID_INTERVAL
INVALID_TIME

EMEM gate, DELETE_EVENT function

The DELETE_EVENT function deletes an event.

Input parameters

EVENT
is the name of the event to be deleted.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
EVENT_NOT_FOUND
INVALID_EVENT_TYPE

EMEM gate, DELETE_TIMER function

The DELETE_TIMER function deletes a timer.

Input parameters

TIMER
is the name of the timer to be deleted.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
TIMER_NOT_FOUND

EMEM gate, FIRE_EVENT function

The FIRE_EVENT function causes an event to fire.

Input parameters

EVENT
is the name of the event to be fired.
EVENT_VERSION
is an optional version number for the event.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
EVENT_NOT_FOUND
INVALID_EVENT_TYPE
ALREADY_FIRED
VERSION_NOT_FOUND

EMEM gate, FORCE_TIMER function

The FORCE_TIMER function causes a timer to expire early.

Input parameters

TIMER
is the name of the timer to be forced.
ACQUIRED_PROCESS
indicates whether or not the timer to be forced is owned by the acquired process. It may have either of these values:
YES|NO
ACQUIRED_ACTIVITY
indicates whether or not the timer to be forced is owned by the acquired activity. It may have either of these values:
YES|NO

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
NO_ACQUIRED_PROCESS
NO_ACQUIRED_ACTIVITY
INVALID_ACTIVITY
TIMER_NOT_FOUND

EMEM gate, INQUIRE_STATUS function

The INQUIRE_STATUS function returns the status of the event pool for the current activity.

Output parameters

PENDING_EVENTS
indicates whether any events are pending. It may have either of these values:
YES|NO
PENDING_ACTIVITY_EVENTS
indicates whether any activity events are pending. It may have either of these values:
YES|NO
REATTACH
indicates whether the task should be reattached. It may have either of these values:
YES|NO
EVENTS_PROCESSED
indicates whether any events were processed during this activation. It may have either of these values:
YES|NO
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NO_CURRENT_ACTIVITY

EMEM gate, REMOVE_SUBEVENT function

The REMOVE_SUBEVENT function removes a subevent from the named composite event.

Input parameters

EVENT
is the name of the composite event.
SUBEVENT
is the name of the subevent.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
EVENT_NOT_FOUND
INVALID_EVENT_TYPE
SUBEVENT_NOT_FOUND
INVALID_SUBEVENT

EMEM gate, RETRIEVE_REATTACH_EVENT function

The RETRIEVE_REATTACH_EVENT function retrieves the next event from the current activity's reattach queue.

Output parameters

EVENT
is the name of the retrieved reattach event.
EVENT_TYPE
is the type of the retrieved reattach event. It may have one of the following values:
ACTIVITY|COMPOSITE|INPUT|SYSTEM|TIMER
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
END_EVENTS

EMEM gate, RETRIEVE_SUBEVENT function

The RETRIEVE_SUBEVENT function retrieves the next event from the named composite event's subevent queue.

Input parameters

EVENT
is the name of the composite event.

Output parameters

SUBEVENT
is the name of the subevent.
EVENT_TYPE
is the type of the retrieved reattach event. It may have one of the following values:
ACTIVITY|COMPOSITE|INPUT|SYSTEM|TIMER
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
EVENT_NOT_FOUND
INVALID_EVENT_TYPE
END_SUBEVENTS
NO_SUBEVENTS

EMEM gate, TEST_EVENT function

The TEST_EVENT function returns the fire status of the named event.

Input parameters

EVENT
is the name of the event to be tested.

Output parameters

FIRED
returns the fire status of the event. It may have either of these values:
YES|NO
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_CURRENT_ACTIVITY
EVENT_NOT_FOUND

EMBR gate, INQUIRE_EVENT function

The INQUIRE_EVENT function returns information about the named event.

Input parameters

EVENT
is the name of the event being inquired upon.

Output parameters

EVENT_TYPE
is the type of the event. It can have one of these values:
ACTIVITY|COMPOSITE|INPUT|SYSTEM|TIMER
FIRED
returns the fire status of the event. It may have either of these values:
YES|NO
PREDICATE
is the predicate type (for composite events only). It may have either one of these values:
AND|OR
PARENT
is the name of the parent (if the event is a subevent).
TIMER_NAME
is the name of the associated timer (if the event is of type timer).
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_ACTIVITY_ID
NO_CURRENT_ACTIVITY
FILE_NOT_AUTH
EVENT_NOT_FOUND
READ_FAILURE
FILE_UNAVAILABLE

EMBR gate, START_BROWSE_EVENT function

The START_BROWSE_EVENT function starts an event browse and returns a token to be used for the browse.

Input parameters

ACTIVITY_ID
is an optional activity id for the activity whose event pool is to be browsed.

Output parameters

BROWSE_TOKEN
returns a token which is used to identify the browse.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_ACTIVITY_ID
FILE_NOT_AUTH
NO_CURRENT_ACTIVITY
READ_FAILURE
FILE_UNAVAILABLE

EMBR gate, GET_NEXT_EVENT function

The GET_NEXT_EVENT function returns the next name in the browse specified by the browse token, and returns the attributes associated with the event.

Input parameters

BROWSE_TOKEN
is a token which identifies the browse.

Output parameters

EVENT
is the name of the event.
EVENT_TYPE
is the type of the event. It can have one of these values:
ACTIVITY|COMPOSITE|INPUT|SYSTEM|TIMER
FIRED
returns the fire status of the event. It may have either of these values:
YES|NO
PREDICATE
is the predicate type (for composite events only). It may have either one of these values:
AND|OR
PARENT
is the name of the parent (if the event is a subevent).
TIMER_NAME
is the name of the associated timer (if the event is of type timer).
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_BROWSE_TOKEN
BROWSE_END

EMBR gate, END_BROWSE_EVENT function

The END_BROWSE_EVENT function ends the event browse identified by the browse token.

Input parameters

BROWSE_TOKEN
is a token which identifies the browse.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION INVALID_BROWSE_TOKEN

EMBR gate, INQUIRE_TIMER function

The INQUIRE_TIMER function returns information about the named timer.

Input parameters

TIMER
is the name of the timer being inquired upon.

Output parameters

EVENT
is the name of the associated event.
TIMER_STATUS
is the status of the timer. It can have one of these values:
EXPIRED|FORCED|UNEXPIRED
ABSTIME
returns the timer's expiry time in ABSTIME format.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_ACTIVITY_ID
NO_CURRENT_ACTIVITY
FILE_NOT_AUTH
TIMER_NOT_FOUND
READ_FAILURE
FILE_UNAVAILABLE

EMBR gate, START_BROWSE_TIMER function

The START_BROWSE_TIMER function starts a timer browse and returns a token to be used for the browse.

Input parameters

ACTIVITY_ID
is an optional activity id for the activity whose event pool is to be browsed.

Output parameters

BROWSE_TOKEN
returns a token which is used to identify the browse.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_ACTIVITY_ID
FILE_NOT_AUTH
NO_CURRENT_ACTIVITY
READ_FAILURE
FILE_UNAVAILABLE

EMBR gate, GET_NEXT_TIMER function

The GET_NEXT_TIMER function returns the next name in the browse specified by the browse token, and returns the attributes associated with the timer.

Input parameters

BROWSE_TOKEN
is the token which identifies the browse.

Output parameters

TIMER
is the name of the timer.
EVENT
is the name of the associated event.
TIMER_STATUS
is the status of the timer. It can have one of these values:
EXPIRED|FORCED|UNEXPIRED
ABSTIME
returns the timer's expiry time in ABSTIME format.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_BROWSE_TOKEN
BROWSE_END

EMBR gate, END_BROWSE_TIMER function

The END_BROWSE_TIMER function ends the timer browse identified by the browse token.

Input parameters

BROWSE_TOKEN
is a token which identifies the browse.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION INVALID_BROWSE_TOKEN
[[ Contents Previous Page | Next Page Index ]]