iox-#2408 add Node builder listener support

Author: jmyvalour

iceoryx_posh/experimental/include/iox/posh/experimental/detail/listener.inl

@@ -0,0 +1,45 @@
+// Copyright (c) 2024 by ekxide IO GmbH. 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_POSH_EXPERIMENTAL_LISTENER_INL
+#define IOX_POSH_EXPERIMENTAL_LISTENER_INL
+
+#include "iox/posh/experimental/listener.hpp"
+
+namespace iox::posh::experimental
+{
+inline ListenerBuilder::ListenerBuilder(runtime::PoshRuntime& runtime) noexcept
+    : m_runtime(runtime)
+{
+}
+
+inline expected<unique_ptr<Listener>, ListenerBuilderError> ListenerBuilder::create() noexcept
+{
+    auto* condition_variable_data = m_runtime.getMiddlewareConditionVariable();
+
+    if (condition_variable_data == nullptr)
+    {
+        return err(ListenerBuilderError::OUT_OF_RESOURCES);
+    }
+    return ok(unique_ptr<Listener>{new (std::nothrow) Listener{*condition_variable_data}, [&](auto* const listener) {
+                                       // NOLINTNEXTLINE(cppcoreguidelines-owning-memory) raw pointer is required by the unique_ptr API
+                                       delete listener;
+                                   }});
+}
+
+} // namespace iox::posh::experimental
+
+#endif // IOX_POSH_EXPERIMENTAL_LISTENER_INL

iceoryx_posh/experimental/include/iox/posh/experimental/listener.hpp

@@ -0,0 +1,58 @@
+// Copyright (c) 2024 by ekxide IO GmbH. 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_POSH_EXPERIMENTAL_LISTENER_HPP
+#define IOX_POSH_EXPERIMENTAL_LISTENER_HPP
+
+#include "iceoryx_posh/iceoryx_posh_types.hpp"
+#include "iceoryx_posh/internal/runtime/posh_runtime_impl.hpp"
+#include "iceoryx_posh/popo/listener.hpp"
+#include "iox/builder.hpp"
+#include "iox/expected.hpp"
+#include "iox/optional.hpp"
+#include "iox/unique_ptr.hpp"
+
+namespace iox::posh::experimental
+{
+
+using Listener = iox::popo::Listener;
+
+enum class ListenerBuilderError : uint8_t
+{
+    OUT_OF_RESOURCES,
+};
+
+/// @brief A builder for the listener
+class ListenerBuilder
+{
+  public:
+    /// @brief Creates a listener
+    /// @return a 'listener' on success and a 'ListenerBuilderError' on failure
+    expected<unique_ptr<Listener>, ListenerBuilderError> create() noexcept;
+
+  private:
+    friend class Node;
+    explicit ListenerBuilder(runtime::PoshRuntime& runtime) noexcept;
+
+  private:
+    // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members) Intentionally used since the ListenerBuilder is not intended to be moved
+    runtime::PoshRuntime& m_runtime;
+};
+} // namespace iox::posh::experimental
+
+#include "iox/posh/experimental/detail/listener.inl"
+
+#endif // IOX_POSH_EXPERIMENTAL_LISTENER_HPP

iceoryx_posh/experimental/include/iox/posh/experimental/node.hpp

@@ -27,6 +27,7 @@
 #include "iox/expected.hpp"
 #include "iox/optional.hpp"
 #include "iox/posh/experimental/client.hpp"
+#include "iox/posh/experimental/listener.hpp"
 #include "iox/posh/experimental/publisher.hpp"
 #include "iox/posh/experimental/server.hpp"
 #include "iox/posh/experimental/subscriber.hpp"
@@ -132,6 +133,9 @@ class Node
     /// @brief Initiates a 'WaitSetBuilder'
     WaitSetBuilder wait_set() noexcept;
 
+    /// @brief Initiates a 'Listener'
+    ListenerBuilder listener() noexcept;
+
     /// @brief Set Node Runtime as default Runtime
     void setDefaultRuntime();
 

iceoryx_posh/experimental/source/node.cpp

@@ -172,6 +172,11 @@ WaitSetBuilder Node::wait_set() noexcept
     return WaitSetBuilder{*m_runtime.get()};
 }
 
+ListenerBuilder Node::listener() noexcept
+{
+    return ListenerBuilder{*m_runtime.get()};
+}
+
 iox::runtime::PoshRuntime& Node::getNodeRuntime([[maybe_unused]] optional<const RuntimeName_t*> name)
 {
     IOX_ASSERT(s_defaultRuntime, "Node Default Runtime has not been created");

iceoryx_posh/include/iceoryx_posh/popo/listener.hpp

@@ -31,6 +31,11 @@
 
 #include <thread>
 
+namespace iox::posh::experimental
+{
+class ListenerBuilder;
+}
+
 namespace iox
 {
 namespace popo
@@ -168,6 +173,7 @@ class Listener
     uint64_t size() const noexcept;
 
   protected:
+    friend class iox::posh::experimental::ListenerBuilder;
     Listener(ConditionVariableData& conditionVariableData) noexcept;
 
   private: