AMiRo-OS

/' OS time measurement feature. '/

$group("time") {

  /' OS time type with arbitrary resolution. '/

  $type("urt_osTime_t") {

      'Converts an OS time to 64 bit microsecond precise value.

    + {method} urtTime2Us (t : urt_osTime_t*) : uint64_t

      'Retrieves the current time.

    + {method} urtTimeNow (void) : urt_osTime_t

      'Increase a system time object.

    + {method} urtTimeAddUs (time : urt_osTime_t*, offset : uint32_t) : urt_osTime_t*

  }

/' OS mutex lock feature. '/

$group("mutex") {

  /' OS mutex lock interface. '/

  $type("urt_osMutex_t") {

      'Initializes a urt_osMutex_t object.

    + {method} urtMutexInit (mutex : urt_osMutex_t*) : void

      'Block the thread until the mutex could be locked.

    + {method} urtMutexLock (mutex : urt_osMutex_t*) : void

      'Tries to lock the mutex, but does not block but immediately returns an indicator.

    + {method} urtMutexTryLock (mutex : urt_osMutex_t*) : bool

      'Unlocks a previously locked mutex.

    + {method} urtMutexUnlock (mutex : urt_osMutex_t*) : void

  }

/' OS streams feature. '/

$group("streams") {

  /' Not a class/type but a set of output-related functions. '/

  $function("urt_streams") {

      'Prints a formatted string to the standard output stream (stdout).

    + {method} urtPrintf(fmt : char*, ... ) : int

      'Prints a formatted string to the standard error stream (stderr).

    + {method} urtErrPrintf(fmt : char*, ... ) : int

  }

}

/' OS debugging feature. '/

$group("debug") {

  /' Just a function for debugging. '/

  $function("urt_debug") {

      'Checks the condition in debug mode.

    + {method} urtDebugAssert(condition : bool) : void

  }