Timer domain’s specific gate

Table 105 summarizes the timer domain’s specific gate. 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 105. Timer domain’s specific gate
Gate Trace Function XPI
TISR
TI 0100
TI 0101
REQUEST_NOTIFY_INTERVAL
REQUEST_NOTIFY_TIME_OF_DAY
CANCEL
INQUIRE_EXPIRATION_TOKEN
NO
NO
NO
NO

TISR gate, REQUEST_NOTIFY_INTERVAL function

The REQUEST_NOTIFY_INTERVAL function of the TISR gate is used to request the timer domain to notify the calling domain after a specified real interval of time. The calling domain can request a NOTIFY on a one-off basis or periodically, and can specify the type of NOTIFY to be expected.

Input parameters

DOMAIN_TOKEN
is a token that is to be passed as a parameter on the NOTIFY call.
STCK_INTERVAL
specifies an interval as a doubleword binary interval in stored clock (STCK) format, where bit 51 of the doubleword represents 1 microsecond.
PERIODIC_NOTIFY
specifies whether the requested NOTIFY is to be repeated at the specified interval until canceled (YES), or is to be just a one-off NOTIFY (NO). It can have either of these values:
YES|NO
NOTIFY_TYPE
specifies whether the attached task or the timer task is to be used to notify the calling domain after the specified interval of time. It can have either of these values:
ATTACHED_TASK|TIMER_TASK
[ATTACH_PRIORITY]
defines the priority, in the range 0 through 255, at which the requested NOTIFY task is to be attached.
[ATTACH_TASK_TIMEOUT]
defines the value, in seconds, of a wait in the attached task after which the dispatcher causes a time-out.
[ATTACH_MODE]
is the optional TCB mode in which the attached NOTIFY task is to run.
[ORIGIN_DATE]
defines the date from which the timer domain is to start the interval timing for this request. This parameter is mandatory if ORIGIN_TIME has been specified. It holds the origin date as MMDDYYYY.
[ORIGIN_TIME]
defines the local time of day from which the timer domain is to start the interval timing for this request. The value in decimal digits is specified in the form HHMMSS:
HH
Hours in the range 00 through 23
MM
Minutes in the range 00 through 59
SS
Seconds in the range 00 through 59.

ORIGIN_TIME defaults to the current time.

Output parameters

TIMER_TOKEN
is the token that is returned by the timer domain. The timer token may be used to cancel the NOTIFY request.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|EXCEPTION|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. It has this value:
INVALID_INTERVAL

TISR gate, REQUEST_NOTIFY_TIME_OF_DAY function

The REQUEST_NOTIFY_TIME_OF_DAY function of the TISR gate is used to inform the timer domain that an alarm call is required from the timer domain (that is, a NOTIFY) at the specified time of day. The calling domain can request a NOTIFY on a one-off basis or daily, and the type of NOTIFY to be expected.

Input parameters

DOMAIN_TOKEN
is the token that is to be passed as a parameter on the NOTIFY call.
REQUESTED_TIME
is the time of day at which the NOTIFY function is to be invoked. The value is specified in the form HHMMSS.
PERIODIC_NOTIFY
specifies whether the requested NOTIFY is to be repeated every day at the requested time (YES), or is to be just a one-off NOTIFY (NO). It can have either of these values:
YES|NO
NOTIFY_TYPE
specifies whether the attached task or the timer task is to be used to notify the calling domain after the specified interval of time. It can have either of these values:
ATTACHED_TASK|TIMER_TASK
[ATTACH_PRIORITY]
defines the priority, in the range 0 through 255, at which the requested NOTIFY task is to be attached.
[ATTACH_TASK_TIMEOUT]
defines the value, in seconds, of a wait in the attached task after which the dispatcher causes a time-out.
[ATTACH_MODE]
is the optional TCB mode in which the attached NOTIFY task is to run.

Output parameters

TIMER_TOKEN
is the token that is returned by the timer domain.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|EXCEPTION|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID. It has this value:
TOO_LATE

TISR gate, CANCEL function

The CANCEL function of the TISR gate is used to cancel a timer request that has already been initiated by one of these functions:

Input parameters

TIMER_TOKEN
is the token that was returned when the timer request was made.

Output parameters

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

TISR gate, INQUIRE_EXPIRATION_TOKEN function

The INQUIRE_EXPIRATION_TOKEN function of the TISR gate is used by the dispatcher domain during its initialization.

Input parameters

None.

Output parameters

EXPIRATION_TOKEN
is a token used during initialization of the dispatcher domain.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|INVALID|EXCEPTION|DISASTER|KERNERROR|PURGED
[[ Contents Previous Page | Next Page Index ]]