time/Nano.fz

# This file is part of the Fuzion language implementation.
#
# The Fuzion language implementation is free software: you can redistribute it
# and/or modify it under the terms of the GNU General Public License as published
# by the Free Software Foundation, version 3 of the License.
#
# The Fuzion language implementation is distributed in the hope that it will be
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
# License for more details.
#
# You should have received a copy of the GNU General Public License along with The
# Fuzion language implementation.  If not, see <https://www.gnu.org/licenses/>.


# -----------------------------------------------------------------------
#
#  Tokiwa Software GmbH, Germany
#
#  Source code of Fuzion standard library feature time.Nano
#
#  Author: Fridtjof Siebert (siebert@tokiwa.software)
#
# -----------------------------------------------------------------------

# time.Nano -- effect providing nano time
#
# time.Nano is a timer that provides high precision but possibly low
# accuracy.  Such a timer is typically useful for timing the duration
# of events, such as measuring the time it takes to perform some
# calculation.
#
# time.Nano may have a significant drift compared to actual time, it might
# not be the right source of time to, e.g., feed an alarm clock that should
# wake you up at 6h30 every morning.
#
public Nano ref : time.Clock is

  # no guarantee can be given for precision nor resolution
  #
  public redef read time.instant => abstract


  # no guarantee can be given for precision nor resolution
  #
  public redef sleep(d time.duration) unit => abstract



  # default implementation of time.Nano.
  #
  public redef fixed type.default_value option time.Nano =>
    _ : time.Nano is

      # no guarantee can be given for precision nor resolution
      #
      public redef read time.instant => time.instant (fzE_posix_time (id posix.clockid_t posix.clock_monotonic).val)

      # no guarantee can be given for precision nor resolution
      #
      public redef sleep(d time.duration) unit => fzE_nanosleep d.nanos