You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celix.apache.org by pn...@apache.org on 2023/06/28 15:23:34 UTC

[celix] 18/42: Rename celix_addDelayInSecondsToTime

This is an automated email from the ASF dual-hosted git repository.

pnoltes pushed a commit to branch feature/scheduled_event_on_event_thread
in repository https://gitbox.apache.org/repos/asf/celix.git

commit 7e3e91f2ac704b494a2bed759e23bb6adf207557
Author: Pepijn Noltes <pn...@apache.org>
AuthorDate: Sat Jun 17 00:23:50 2023 +0200

    Rename celix_addDelayInSecondsToTime
---
 libs/framework/src/celix_scheduled_event.c |  8 ++++----
 libs/utils/gtest/src/ThreadsTestSuite.cc   |  2 +-
 libs/utils/gtest/src/TimeUtilsTestSuite.cc | 18 +++++++++---------
 libs/utils/include/celix_utils.h           |  4 ++--
 libs/utils/src/celix_threads.c             |  2 +-
 libs/utils/src/utils.c                     |  2 +-
 6 files changed, 18 insertions(+), 18 deletions(-)

diff --git a/libs/framework/src/celix_scheduled_event.c b/libs/framework/src/celix_scheduled_event.c
index 2ab4ee11..d2707e28 100644
--- a/libs/framework/src/celix_scheduled_event.c
+++ b/libs/framework/src/celix_scheduled_event.c
@@ -241,7 +241,7 @@ celix_status_t celix_scheduledEvent_waitForAtLeastCallCount(celix_scheduled_even
     celix_status_t status = CELIX_SUCCESS;
     if (waitTimeInSeconds > 0) {
         struct timespec start = celix_gettime(CLOCK_REALTIME);
-        struct timespec absTimeoutTime = celix_addDelayInSecondsToTime(&start, waitTimeInSeconds);
+        struct timespec absTimeoutTime = celix_delayedTimespec(&start, waitTimeInSeconds);
         celixThreadMutex_lock(&event->mutex);
         while (event->callCount < targetCallCount) {
             celixThreadCondition_waitUntil(&event->cond, &event->mutex, &absTimeoutTime);
@@ -258,7 +258,7 @@ celix_status_t celix_scheduledEvent_waitForAtLeastCallCount(celix_scheduled_even
 
 void celix_scheduledEvent_waitForRemoved(celix_scheduled_event_t* event) {
     struct timespec start = celix_gettime(CLOCK_REALTIME);
-    struct timespec absLogTimeout = celix_addDelayInSecondsToTime(&start, CELIX_SCHEDULED_EVENT_ERROR_LOG_TIMEOUT_IN_SECONDS);
+    struct timespec absLogTimeout = celix_delayedTimespec(&start, CELIX_SCHEDULED_EVENT_ERROR_LOG_TIMEOUT_IN_SECONDS);
     celixThreadMutex_lock(&event->mutex);
     while (!event->isRemoved) {
         celix_status_t waitStatus = celixThreadCondition_waitUntil(&event->cond, &event->mutex, &absLogTimeout);
@@ -270,7 +270,7 @@ void celix_scheduledEvent_waitForRemoved(celix_scheduled_event_t* event) {
                    event->scheduledEventId,
                    event->bndId);
             start = celix_gettime(CLOCK_REALTIME);
-            absLogTimeout = celix_addDelayInSecondsToTime(&start, CELIX_SCHEDULED_EVENT_ERROR_LOG_TIMEOUT_IN_SECONDS);
+            absLogTimeout = celix_delayedTimespec(&start, CELIX_SCHEDULED_EVENT_ERROR_LOG_TIMEOUT_IN_SECONDS);
         }
     }
     celixThreadMutex_unlock(&event->mutex);
@@ -281,7 +281,7 @@ celix_status_t celix_scheduledEvent_wait(celix_scheduled_event_t* event, double
     celixThreadMutex_lock(&event->mutex);
     size_t targetCallCount = event->callCount + 1;
     struct timespec start = celix_gettime(CLOCK_REALTIME);
-    struct timespec absTimeoutTime = celix_addDelayInSecondsToTime(&start, timeoutInSeconds);
+    struct timespec absTimeoutTime = celix_delayedTimespec(&start, timeoutInSeconds);
     while (event->callCount < targetCallCount) {
         celix_status_t waitStatus = celixThreadCondition_waitUntil(&event->cond, &event->mutex, &absTimeoutTime);
         if (waitStatus == ETIMEDOUT) {
diff --git a/libs/utils/gtest/src/ThreadsTestSuite.cc b/libs/utils/gtest/src/ThreadsTestSuite.cc
index 3d160037..d19baa00 100644
--- a/libs/utils/gtest/src/ThreadsTestSuite.cc
+++ b/libs/utils/gtest/src/ThreadsTestSuite.cc
@@ -304,7 +304,7 @@ TEST_F(ThreadsTestSuite, CondTimedWaitTest) {
 
     //Test with valid abstime
     auto start = celix_gettime(CLOCK_REALTIME);
-    auto targetEnd = celix_addDelayInSecondsToTime(&start, 0.001);
+    auto targetEnd = celix_delayedTimespec(&start, 0.001);
     pthread_mutex_lock(&mutex);
     status = celixThreadCondition_waitUntil(&cond, &mutex, &targetEnd);
     ASSERT_EQ(status, ETIMEDOUT);
diff --git a/libs/utils/gtest/src/TimeUtilsTestSuite.cc b/libs/utils/gtest/src/TimeUtilsTestSuite.cc
index f0f26198..2aff69a4 100644
--- a/libs/utils/gtest/src/TimeUtilsTestSuite.cc
+++ b/libs/utils/gtest/src/TimeUtilsTestSuite.cc
@@ -56,56 +56,56 @@ TEST_F(TimeUtilsTestSuite, ElapsedTimeTest) {
     EXPECT_LT(diff, 0.1 /*1/10 s, note do want to rely on accuracy of sleep_for*/);
 }
 
-TEST_F(TimeUtilsTestSuite, AddDelayInSecondsToTimeTest) {
+TEST_F(TimeUtilsTestSuite, DelayedTimespecTest) {
     //Test with NULL time and delayInSeconds = 0
-    struct timespec delayedTime = celix_addDelayInSecondsToTime(NULL, 0);
+    struct timespec delayedTime = celix_delayedTimespec(NULL, 0);
     ASSERT_EQ(delayedTime.tv_sec, 0);
     ASSERT_EQ(delayedTime.tv_nsec, 0);
 
     //Test with NULL time and delayInSeconds = 1.5
-    delayedTime = celix_addDelayInSecondsToTime(NULL, 1.5);
+    delayedTime = celix_delayedTimespec(NULL, 1.5);
     struct timespec expectedTime = {1, 500000000};
     ASSERT_EQ(delayedTime.tv_sec, expectedTime.tv_sec);
     ASSERT_EQ(delayedTime.tv_nsec, expectedTime.tv_nsec);
 
     //Test with time.tv_nsec + nanoseconds > CELIX_NS_IN_SEC
     struct timespec time = {0, 500000000};
-    delayedTime = celix_addDelayInSecondsToTime(&time, 0.6);
+    delayedTime = celix_delayedTimespec(&time, 0.6);
     expectedTime = {1, 100000000};
     ASSERT_EQ(delayedTime.tv_sec, expectedTime.tv_sec);
     ASSERT_EQ(delayedTime.tv_nsec, expectedTime.tv_nsec);
 
     //Test with time.tv_nsec + nanoseconds < 0
     time = {1, 500000000};
-    delayedTime = celix_addDelayInSecondsToTime(&time, -0.6);
+    delayedTime = celix_delayedTimespec(&time, -0.6);
     expectedTime = {0, 900000000};
     ASSERT_EQ(delayedTime.tv_sec, expectedTime.tv_sec);
     ASSERT_EQ(delayedTime.tv_nsec, expectedTime.tv_nsec);
 
     //Test with time.tv_nsec + nanoseconds = CELIX_NS_IN_SEC
     time = {1, 500000000};
-    delayedTime = celix_addDelayInSecondsToTime(&time, 0.5);
+    delayedTime = celix_delayedTimespec(&time, 0.5);
     expectedTime = {2, 0};
     ASSERT_EQ(delayedTime.tv_sec, expectedTime.tv_sec);
     ASSERT_EQ(delayedTime.tv_nsec, expectedTime.tv_nsec);
 
     //Test with time.tv_nsec + nanoseconds < CELIX_NS_IN_SEC
     time = {1, 500000000};
-    delayedTime = celix_addDelayInSecondsToTime(&time, 0.4);
+    delayedTime = celix_delayedTimespec(&time, 0.4);
     expectedTime = {1, 900000000};
     ASSERT_EQ(delayedTime.tv_sec, expectedTime.tv_sec);
     ASSERT_EQ(delayedTime.tv_nsec, expectedTime.tv_nsec);
 
     //Test if time becomes negative
     time = {0, 500000000};
-    delayedTime = celix_addDelayInSecondsToTime(&time, -1.5);
+    delayedTime = celix_delayedTimespec(&time, -1.5);
     expectedTime = {-1, 0};
     ASSERT_EQ(delayedTime.tv_sec, expectedTime.tv_sec);
     ASSERT_EQ(delayedTime.tv_nsec, expectedTime.tv_nsec);
 
     //Test delay <= -2 seconds
     time = {3, 0};
-    delayedTime = celix_addDelayInSecondsToTime(&time, -2.6);
+    delayedTime = celix_delayedTimespec(&time, -2.6);
     expectedTime = {0, 400000000};
     ASSERT_EQ(delayedTime.tv_sec, expectedTime.tv_sec);
     ASSERT_EQ(delayedTime.tv_nsec, expectedTime.tv_nsec);
diff --git a/libs/utils/include/celix_utils.h b/libs/utils/include/celix_utils.h
index f33413fd..eab3484a 100644
--- a/libs/utils/include/celix_utils.h
+++ b/libs/utils/include/celix_utils.h
@@ -163,8 +163,8 @@ CELIX_UTILS_EXPORT struct timespec celix_gettime(clockid_t clockId);
  * @param[in] time The time to add the delay to. Can be NULL, in which case the time is 0.
  * @param[in] delayInSeconds The delay in seconds.
  * @return A new time with the delay added.
-*/
-CELIX_UTILS_EXPORT struct timespec celix_addDelayInSecondsToTime(const struct timespec* time, double delayInSeconds);
+ */
+CELIX_UTILS_EXPORT struct timespec celix_delayedTimespec(const struct timespec* time, double delayInSeconds);
 
 /**
  * @brief Returns the elapsed time - in seconds - relative to the startTime
diff --git a/libs/utils/src/celix_threads.c b/libs/utils/src/celix_threads.c
index eb01fa2c..f06775d9 100644
--- a/libs/utils/src/celix_threads.c
+++ b/libs/utils/src/celix_threads.c
@@ -204,7 +204,7 @@ CELIX_UTILS_EXPORT celix_status_t celixThreadCondition_waitFor(celix_thread_cond
         return CELIX_ILLEGAL_ARGUMENT;
     }
     struct timespec now = celix_gettime(CLOCK_MONOTONIC);
-    struct timespec abstime = celix_addDelayInSecondsToTime(&now, delayInSeconds);
+    struct timespec abstime = celix_delayedTimespec(&now, delayInSeconds);
     return celixThreadCondition_waitUntil(cond, mutex, &abstime);
 }
 
diff --git a/libs/utils/src/utils.c b/libs/utils/src/utils.c
index 905ca301..ed5cbfa4 100644
--- a/libs/utils/src/utils.c
+++ b/libs/utils/src/utils.c
@@ -266,7 +266,7 @@ struct timespec celix_gettime(clockid_t clockId) {
     return t;
 }
 
-struct timespec celix_addDelayInSecondsToTime(const struct timespec* time, double delayInSeconds) {
+struct timespec celix_delayedTimespec(const struct timespec* time, double delayInSeconds) {
     struct timespec delayedTime;
     if (time != NULL) {
         delayedTime = *time;