iox-1391 Move time-related classes to Time module

.clang-tidy-diff-scans.txt

@@ -45,6 +45,8 @@
 ./iceoryx_hoofs/test/moduletests/test_polymorphic_handler.cpp
 ./iceoryx_hoofs/test/moduletests/test_static_lifetime_guard.cpp
 
+./iceoryx_hoofs/posix/**/*
+
 ./iceoryx_hoofs/container/include/iox/**/*
 ./iceoryx_hoofs/test/moduletests/test_container_*
 
@@ -53,6 +55,14 @@
 
 ./iceoryx_hoofs/design/**/*
 ./iceoryx_hoofs/test/moduletests/test_design_*
+./iceoryx_hoofs/utility/**/*
+./iceoryx_hoofs/test/moduletests/test_utility_*
+
+./iceoryx_hoofs/primitives/**/*
+./iceoryx_hoofs/test/moduletests/test_primitives_*
+
+./iceoryx_hoofs/time/**/*
+./iceoryx_hoofs/test/moduletests/test_time_*
 
 # IMPORTANT:
 #    after the first # everything is considered a comment, add new files and

doc/website/release-notes/iceoryx-unreleased.md

@@ -998,3 +998,25 @@
     // iox::string to std::string
     std::string myConvertedIoxString = iox::into<std::string>(myIoxString);
     ```
+
+44. Move and rename `DeadlineTimer`
+
+    ```cpp
+    // before
+    #include "iceoryx_hoofs/cxx/deadline_timer.hpp"
+    iox::cxx::DeadlineTimer myTimer;
+
+    // after
+    #include "iox/deadline_timer.hpp"
+    iox::deadline_timer myTimer;
+    ```
+
+45. Changed include path of `iox::units::Duration`
+
+    ```cpp
+    // before
+    #include "iceoryx_hoofs/internal/units/duration.hpp"
+
+    // after
+    #include "iox/duration.hpp"
+    ```

iceoryx_dust/include/iceoryx_dust/posix_wrapper/message_queue.hpp

@@ -19,10 +19,10 @@
 
 #include "iceoryx_dust/design/creation.hpp"
 #include "iceoryx_hoofs/internal/posix_wrapper/ipc_channel.hpp"
-#include "iceoryx_hoofs/internal/units/duration.hpp"
 #include "iceoryx_platform/fcntl.hpp"
 #include "iceoryx_platform/mqueue.hpp"
 #include "iceoryx_platform/stat.hpp"
+#include "iox/duration.hpp"
 #include "iox/optional.hpp"
 
 namespace iox

iceoryx_dust/include/iceoryx_dust/posix_wrapper/named_pipe.hpp

@@ -20,9 +20,9 @@
 #include "iceoryx_hoofs/concurrent/lockfree_queue.hpp"
 #include "iceoryx_hoofs/internal/posix_wrapper/ipc_channel.hpp"
 #include "iceoryx_hoofs/internal/posix_wrapper/shared_memory_object.hpp"
-#include "iceoryx_hoofs/internal/units/duration.hpp"
 #include "iceoryx_hoofs/posix_wrapper/unnamed_semaphore.hpp"
 #include "iceoryx_platform/semaphore.hpp"
+#include "iox/duration.hpp"
 #include "iox/expected.hpp"
 #include "iox/optional.hpp"
 #include "iox/string.hpp"

iceoryx_dust/source/posix_wrapper/named_pipe.cpp

@@ -16,7 +16,7 @@
 
 #include "iceoryx_dust/posix_wrapper/named_pipe.hpp"
 #include "iceoryx_dust/cxx/std_string_support.hpp"
-#include "iceoryx_hoofs/cxx/deadline_timer.hpp"
+#include "iox/deadline_timer.hpp"
 #include "iox/into.hpp"
 
 #include <thread>
@@ -389,7 +389,7 @@ bool NamedPipe::NamedPipeData::waitForInitialization() const noexcept
         return true;
     }
 
-    cxx::DeadlineTimer deadlineTimer(WAIT_FOR_INIT_TIMEOUT);
+    deadline_timer deadlineTimer(WAIT_FOR_INIT_TIMEOUT);
 
     while (!deadlineTimer.hasExpired())
     {

iceoryx_examples/iceperf/base.hpp

@@ -20,7 +20,7 @@
 #include "example_common.hpp"
 #include "topic_data.hpp"
 
-#include "iceoryx_hoofs/internal/units/duration.hpp"
+#include "iox/duration.hpp"
 
 #include <chrono>
 #include <iostream>

iceoryx_examples/iceperf/mq.hpp

@@ -20,10 +20,10 @@
 #include "base.hpp"
 
 #include "iceoryx_hoofs/internal/posix_wrapper/ipc_channel.hpp"
-#include "iceoryx_hoofs/internal/units/duration.hpp"
 #include "iceoryx_platform/fcntl.hpp"
 #include "iceoryx_platform/mqueue.hpp"
 #include "iceoryx_platform/stat.hpp"
+#include "iox/duration.hpp"
 #include "iox/optional.hpp"
 
 #include <string>

iceoryx_hoofs/BUILD.bazel

@@ -35,8 +35,9 @@ cc_library(
         "source/**/*.hpp",
         "memory/source/*.cpp",
         "design/source/*.cpp",
+        "posix/time/source/*.cpp",
     ]),
-    hdrs = glob(["include/**"]) + glob(["legacy/**"]) + glob(["memory/**"]) + glob(["container/**"]) + glob(["vocabulary/**"]) + glob(["utility/**"]) + glob(["primitives/**"]) + glob(["design/**"]) + [
+    hdrs = glob(["include/**"]) + glob(["legacy/**"]) + glob(["memory/**"]) + glob(["container/**"]) + glob(["vocabulary/**"]) + glob(["time/**"]) + glob(["utility/**"]) + glob(["primitives/**"]) + glob(["posix/**"]) + glob(["design/**"]) + [
         ":iceoryx_hoofs_deployment_hpp",
     ],
     includes = [
@@ -45,7 +46,9 @@ cc_library(
         "include/",
         "legacy/include/",
         "memory/include/",
+        "posix/time/include/",
         "primitives/include/",
+        "time/include/",
         "utility/include/",
         "vocabulary/include/",
     ],

iceoryx_hoofs/CMakeLists.txt

@@ -54,6 +54,8 @@ iox_add_library(
                                 ${PROJECT_SOURCE_DIR}/utility/include
                                 ${PROJECT_SOURCE_DIR}/primitives/include
                                 ${PROJECT_SOURCE_DIR}/design/include
+                                ${PROJECT_SOURCE_DIR}/time/include
+                                ${PROJECT_SOURCE_DIR}/posix/time/include
                                 ${CMAKE_BINARY_DIR}/generated/iceoryx_hoofs/include
     INSTALL_INTERFACE           include/${PREFIX}
     EXPORT_INCLUDE_DIRS         include/
@@ -64,10 +66,12 @@ iox_add_library(
                                 utility/include/
                                 primitives/include/
                                 design/include/
+                                time/include/
+                                posix/time/include/
     FILES
         source/concurrent/loffli.cpp
-        source/cxx/adaptive_wait.cpp
-        source/cxx/deadline_timer.cpp
+        posix/time/source/adaptive_wait.cpp
+        posix/time/source/deadline_timer.cpp
         source/cxx/filesystem.cpp
         source/cxx/requires.cpp
         source/cxx/type_traits.cpp

iceoryx_hoofs/README.md

@@ -169,7 +169,7 @@ setTimeout(5_ms); // 5 milliseconds
 | class               | internal | description                                                                                                                                 |
 |:-------------------:|:--------:|:--------------------------------------------------------------------------------------------------------------------------------------------|
 |`Duration`           | i        | Represents the unit time, is convertible to `timespec` and `timeval`. User defined literals are available for convenience and readability.  |
-|`DeadlineTimer`      |          | Polling based timer to check for an elapsed deadline.                                                                                       |
+|`deadline_timer      |          | Polling based timer to check for an elapsed deadline.                                                                                       |
 |`adaptive_wait`      | i        | Building block to realize busy waiting loops with low CPU load.                                                                             |
 
 <center>

iceoryx_hoofs/include/iceoryx_hoofs/internal/concurrent/periodic_task.hpp

@@ -17,9 +17,9 @@
 #ifndef IOX_HOOFS_CONCURRENT_PERIODIC_TASK_HPP
 #define IOX_HOOFS_CONCURRENT_PERIODIC_TASK_HPP
 
-#include "iceoryx_hoofs/internal/units/duration.hpp"
 #include "iceoryx_hoofs/posix_wrapper/thread.hpp"
 #include "iceoryx_hoofs/posix_wrapper/unnamed_semaphore.hpp"
+#include "iox/duration.hpp"
 #include "iox/string.hpp"
 
 #include <thread>
@@ -46,7 +46,7 @@ static constexpr PeriodicTaskManualStart_t PeriodicTaskManualStart;
 ///        This can be a struct with a 'operator()()' overload, a 'cxx::function_ref<void()>' or 'std::fuction<void()>'.
 /// @code
 /// #include <iceoryx_hoofs/internal/concurrent/periodic_task.hpp>
-/// #include <iceoryx_hoofs/internal/units/duration.hpp>
+/// #include <iox/duration.hpp>
 /// #include <iostream>
 ///
 /// int main()

iceoryx_hoofs/include/iceoryx_hoofs/internal/posix_wrapper/semaphore_interface.hpp

@@ -16,8 +16,8 @@
 #ifndef IOX_HOOFS_POSIX_WRAPPER_SEMAPHORE_INTERFACE_HPP
 #define IOX_HOOFS_POSIX_WRAPPER_SEMAPHORE_INTERFACE_HPP
 
-#include "iceoryx_hoofs/internal/units/duration.hpp"
 #include "iceoryx_platform/semaphore.hpp"
+#include "iox/duration.hpp"
 #include "iox/expected.hpp"
 
 namespace iox

iceoryx_hoofs/include/iceoryx_hoofs/internal/posix_wrapper/unix_domain_socket.hpp

@@ -19,12 +19,12 @@
 
 #include "iceoryx_hoofs/cxx/filesystem.hpp"
 #include "iceoryx_hoofs/internal/posix_wrapper/ipc_channel.hpp"
-#include "iceoryx_hoofs/internal/units/duration.hpp"
 #include "iceoryx_platform/fcntl.hpp"
 #include "iceoryx_platform/platform_settings.hpp"
 #include "iceoryx_platform/socket.hpp"
 #include "iceoryx_platform/stat.hpp"
 #include "iceoryx_platform/un.hpp"
+#include "iox/duration.hpp"
 #include "iox/optional.hpp"
 
 namespace iox

iceoryx_hoofs/legacy/include/iceoryx_hoofs/cxx/deadline_timer.hpp

@@ -0,0 +1,33 @@
+// Copyright (c) 2023 by Apex.AI Inc. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+#ifndef IOX_HOOFS_CXX_DEADLINE_TIMER_HPP
+#define IOX_HOOFS_CXX_DEADLINE_TIMER_HPP
+
+#include "iox/deadline_timer.hpp"
+
+namespace iox
+{
+/// @todo iox-#1593 Deprecate include
+/// [[deprecated("Deprecated in 3.0, removed in 4.0, please include 'iox/deadline_timer.hpp' instead")]]
+namespace cxx
+{
+/// @deprecated use `iox::deadline_timer` instead of `iox::cxx::DeadlineTimer`
+using DeadlineTimer = iox::deadline_timer;
+} // namespace cxx
+} // namespace iox
+
+#endif // IOX_HOOFS_CXX_DEADLINE_TIMER_HPP

iceoryx_hoofs/include/iceoryx_hoofs/cxx/deadline_timer.hpp → iceoryx_hoofs/posix/time/include/iox/deadline_timer.hpp

@@ -13,24 +13,22 @@
 // limitations under the License.
 //
 // SPDX-License-Identifier: Apache-2.0
-#ifndef IOX_HOOFS_CXX_DEADLINETIMER_HPP
-#define IOX_HOOFS_CXX_DEADLINETIMER_HPP
+#ifndef IOX_HOOFS_TIME_DEADLINE_TIMER_HPP
+#define IOX_HOOFS_TIME_DEADLINE_TIMER_HPP
 
-#include "iceoryx_hoofs/internal/units/duration.hpp"
 #include "iceoryx_platform/signal.hpp"
+#include "iox/duration.hpp"
 
 #include <chrono>
 #include <cstdint>
 
 namespace iox
 {
-namespace cxx
-{
 /// @brief This offers the deadline timer functionality. It has user convenient methods to reset the timer [by default
 /// it uses the intialized duration], reset timer to a customized duration, check if the timer is active and user can
 /// also get to know about the remaining time before the timer goes off
 /// @code
-///     iox::cxx::DeadlineTimer deadlineTimer(1000_ms);
+///     iox::cxx::deadline_timer deadlineTimer(1000_ms);
 ///
 ///     // to check if the timer is active
 ///     if( deadlineTimer.hasExpired()){
@@ -40,12 +38,12 @@ namespace cxx
 ///     deadlineTimer.reset();
 ///
 /// @endcode
-class DeadlineTimer
+class deadline_timer
 {
   public:
     /// @brief Constructor
     /// @param[in] timeToWait duration until the timer expires
-    explicit DeadlineTimer(const iox::units::Duration timeToWait) noexcept;
+    explicit deadline_timer(const iox::units::Duration timeToWait) noexcept;
 
     /// @brief Checks if the timer has expired compared to its absolute end time
     /// @return false if the timer is still active and true if it is expired
@@ -71,9 +69,7 @@ class DeadlineTimer
     iox::units::Duration m_timeToWait;
     iox::units::Duration m_endTime;
 };
-
-} // namespace cxx
 } // namespace iox
 
 
-#endif // IOX_HOOFS_CXX_DEADLINETIMER_HPP
+#endif // IOX_HOOFS_TIME_DEADLINE_TIMER_HPP

iceoryx_hoofs/include/iceoryx_hoofs/internal/cxx/adaptive_wait.hpp → iceoryx_hoofs/posix/time/include/iox/detail/adaptive_wait.hpp

@@ -14,19 +14,17 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#ifndef IOX_HOOFS_CXX_ADAPTIVE_WAIT_HPP
-#define IOX_HOOFS_CXX_ADAPTIVE_WAIT_HPP
+#ifndef IOX_HOOFS_TIME_ADAPTIVE_WAIT_HPP
+#define IOX_HOOFS_TIME_ADAPTIVE_WAIT_HPP
 
 #include "iceoryx_hoofs/cxx/function_ref.hpp"
-#include "iceoryx_hoofs/internal/units/duration.hpp"
+#include "iox/duration.hpp"
 
 #include <cstdint>
 
 namespace iox
 {
-namespace cxx
-{
-namespace internal
+namespace detail
 {
 /// @brief Building block to implement a busy waiting loop efficiently. It
 ///        pursues a strategy where in the beginning the behavior is like a
@@ -56,7 +54,7 @@ class adaptive_wait
 
     /// @brief Waits in a loop in a smart wait until continueToWait returns false.
     /// @param[in] continueToWait callable which returns if the wait should continue
-    void wait_loop(const function_ref<bool()>& continueToWait) noexcept;
+    void wait_loop(const cxx::function_ref<bool()>& continueToWait) noexcept;
 
   protected:
     /// @note All numbers are not accurate and are just rough estimates
@@ -104,8 +102,7 @@ class adaptive_wait
   private:
     uint64_t m_yieldCount = 0U;
 };
-} // namespace internal
-} // namespace cxx
+} // namespace detail
 } // namespace iox
 
-#endif
+#endif // IOX_HOOFS_TIME_ADAPTIVE_WAIT_HPP

iceoryx_hoofs/source/cxx/adaptive_wait.cpp → iceoryx_hoofs/posix/time/source/adaptive_wait.cpp

@@ -14,15 +14,13 @@
 //
 // SPDX-License-Identifier: Apache-2.0
 
-#include "iceoryx_hoofs/internal/cxx/adaptive_wait.hpp"
+#include "iox/detail/adaptive_wait.hpp"
 
 #include <thread>
 
 namespace iox
 {
-namespace cxx
-{
-namespace internal
+namespace detail
 {
 constexpr std::chrono::microseconds adaptive_wait::INITIAL_WAITING_TIME;
 constexpr std::chrono::milliseconds adaptive_wait::FINAL_WAITING_TIME;
@@ -47,13 +45,12 @@ void adaptive_wait::wait() noexcept
     }
 }
 
-void adaptive_wait::wait_loop(const function_ref<bool()>& continueToWait) noexcept
+void adaptive_wait::wait_loop(const cxx::function_ref<bool()>& continueToWait) noexcept
 {
     while (continueToWait())
     {
         wait();
     }
 }
-} // namespace internal
-} // namespace cxx
+} // namespace detail
 } // namespace iox