dali/internal/system/common/time-service.h

   1 #ifndef DALI_INTERNAL_TIME_SERVICE_H
   2 #define DALI_INTERNAL_TIME_SERVICE_H
   3
   4 /*
   5  * Copyright (c) 2021 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 #include <stdint.h>
  22
  23 namespace Dali
  24 {
  25 namespace Internal
  26 {
  27 namespace Adaptor
  28 {
  29 namespace TimeService
  30 {
  31 /**
  32  * @brief Get the monotonic time since the clock's epoch.
  33  *
  34  * @param[out]  timeInNanoseconds  The time in nanoseconds since the reference point.
  35  *
  36  * @note The maximum value timeInNanoseconds can hold is 0xFFFFFFFFFFFFFFFF which is 1.844674407e+19. Therefore, this can overflow after approximately 584 years.
  37  */
  38 void GetNanoseconds(uint64_t& timeInNanoseconds);
  39
  40 /**
  41  * @brief Get the monotonic time since the clock's epoch.
  42  *
  43  * @return The time in milliseconds since the reference point.
  44  *
  45  * @note The maximum value that can be returned is 0xFFFFFFFF which is 4,294,967,295. Therefore, this can overflow after approximately 49 days.
  46  */
  47 uint32_t GetMilliSeconds();
  48
  49 /**
  50  * @brief Sleeps until the monotonic time specified since the clock's epoch.
  51  *
  52  * If the time specified has already passed, then it returns immediately.
  53  *
  54  * @param[in]  timeInNanoseconds  The time to sleep until
  55  *
  56  * @note The maximum value timeInNanoseconds can hold is 0xFFFFFFFFFFFFFFFF which is 1.844674407e+19. Therefore, this can overflow after approximately 584 years.
  57  */
  58 void SleepUntil(uint64_t timeInNanoseconds);
  59
  60 } // namespace TimeService
  61
  62 } // namespace Adaptor
  63
  64 } // namespace Internal
  65
  66 } // namespace Dali
  67
  68 #endif // DALI_INTERNAL_TIME_SERVICE_H