TIME_$WAIT                        Domain/OS                         TIME_$WAIT


NAME
     time_$wait - wait for an interval

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/time.h>

     void time_$wait(
          time_$rel_abs_t &rel_abs,
          time_$clock_t &clock_value,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/time.ins.pas';

     procedure time_$wait(
          var rel_abs: time_$rel_abs_t ;
          in clock_value: time_$clock_t ;
          out status: status_$t);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/time.ins.ftn'

           integer*2 clock_value(3), clockl, rel_abs
           integer*4 clockh, status

           equivalence (clockl, clock_value(3)), (clockh, clock_value(1))

           call time_$wait(rel_abs, clock_value, status)

DESCRIPTION
     Time_$wait returns after the interval specified by rel_abs and
     clock_value.

     rel_abs
          The type of clock value supplied supplied in clock_value.  It can
          have one of the following values:

          time_$relative
               Clock_value specifies a relative interval to wait before
               returning.  Time_$wait will return after the number of 4-
               microsecond periods specified by clock_value have elapsed.

          time_$absolute
               Clock_value specifies a system clock value at which time_$wait
               should return.

     clock_value
          A clock value specifying a relative or absolute time to wait for
          before returning.

     status
          The completion status.  If the completion status is time_$wait_quit,
          then time_$wait returned because of an asynchronous fault, not
          because the specified interval elapsed.

NOTES
     Note that time_$wait expects a Coordinated Universal Time (UTC) time in
     clock_value if rel_abs equals time_$absolute.  To convert local time into
     UTC time, use cal_$remove_local_offset.

SEE ALSO
     ec2_$wait, ec2_$wait_slow_io, ec2_$wait_svc.  suspend(ed)(s)(ing)
     stop(ed)(s)(ing) process(s) for specify(ed)(s)(ing) time(ed)(s)(ing)
     wait(ed)(s)(ing) time_$"