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) 2019 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
  26 namespace Internal
  27 {
  28
  29 namespace Adaptor
  30 {
  31
  32 namespace TimeService
  33 {
  34
  35 /**
  36  * @brief Get the monotonic time since the clock's epoch.
  37  *
  38  * @param[out]  timeInNanoseconds  The time in nanoseconds since the reference point.
  39  *
  40  * @note The maximum value timeInNanoseconds can hold is 0xFFFFFFFFFFFFFFFF which is 1.844674407e+19. Therefore, this can overflow after approximately 584 years.
  41  */
  42 void GetNanoseconds( uint64_t& timeInNanoseconds );
  43
  44 /**
  45  * @brief Get the monotonic time since the clock's epoch.
  46  *
  47  * @return The time in milliseconds since the reference point.
  48  *
  49  * @note The maximum value that can be returned is 0xFFFFFFFF which is 4,294,967,295. Therefore, this can overflow after approximately 49 days.
  50  */
  51 uint32_t GetMilliSeconds();
  52
  53 /**
  54  * @brief Sleeps until the monotonic time specified since the clock's epoch.
  55  *
  56  * If the time specified has already passed, then it returns immediately.
  57  *
  58  * @param[in]  timeInNanoseconds  The time to sleep until
  59  *
  60  * @note The maximum value timeInNanoseconds can hold is 0xFFFFFFFFFFFFFFFF which is 1.844674407e+19. Therefore, this can overflow after approximately 584 years.
  61  */
  62 void SleepUntil( uint64_t timeInNanoseconds );
  63
  64 } // namespace TimeService
  65
  66 } // namespace Adaptor
  67
  68 } // namespace Internal
  69
  70 } // namespace Dali
  71
  72 #endif // DALI_INTERNAL_TIME_SERVICE_H