Merge pull request #1863 from ApexAI/iox-1391-move-time-classes-to-time-module

iox-1391 Move time-related classes to `Time` module

Author: mossmaurice-apexai

.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>