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.
- 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.
- Values for the parameter are:
- ATTACHED_TASK
- TIMER_TASK
- 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).
- Values for the parameter are:
- NO
- YES
- STCK_INTERVAL
- specifies an interval as a doubleword binary interval in stored clock (STCK) format, where bit 51 of the doubleword represents 1 microsecond.
- ATTACH_MODE
- Optional Parameter
- is the optional TCB mode in which the attached NOTIFY task is to run.
- Values for the parameter are:
- CO
- FO
- QR
- RO
- ATTACH_PRIORITY
- Optional Parameter
- defines the priority, in the range 0 through 255, at which the requested NOTIFY task is to be attached.
- ATTACH_TASK_TIMEOUT
- Optional Parameter
- defines the value, in seconds, of a wait in the attached task after which the dispatcher causes a timeout.
- ORIGIN_DATE
- Optional Parameter
- 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
- Optional Parameter
- 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
Output Parameters
- REASON
- The values for the parameter are:
- INVALID_INTERVAL
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- TIMER_TOKEN
- is the token that is returned by the timer domain. The timer token may be used to cancel the NOTIFY request.