[eclipse-iceoryx#264] CPP-Node creation API

examples/c/publish_subscribe/src/publisher.c

@@ -10,16 +10,17 @@
 //
 // SPDX-License-Identifier: Apache-2.0 OR MIT
 
-#include "iox2/iceoryx2.h"
-
 #include <stdint.h>
 #include <stdio.h>
 
+#include "iox2/iceoryx2.h"
+
 int main(void) {
  iox2_node_builder_h node_builder_handle = iox2_node_builder_new(NULL);
  iox2_node_h node_handle;
- int ret_val = iox2_node_builder_create(node_builder_handle, NULL, iox2_node_type_e_ZERO_COPY, &node_handle);
- if(ret_val != IOX2_OK) {
+ int ret_val = iox2_node_builder_create(
+ node_builder_handle, NULL, iox2_node_type_e_ZERO_COPY, &node_handle);
+ if (ret_val != IOX2_OK) {
  printf("Could not create node! Error code: %i", ret_val);
  return -1;
  }

examples/cxx/publish_subscribe/src/publisher.cpp

@@ -14,10 +14,11 @@
 
 int main() {
  using namespace iox2;
- auto node = NodeBuilder();
- // .name(NodeName::create("hello world").expect("valid node name"))
- // .template create<NodeType::ZERO_COPY>()
- // .expect("successful node creation");
+ auto node =
+ NodeBuilder()
+ .name(NodeName::create("hello world").expect("valid node name"))
+ .template create<NodeType::ZERO_COPY>()
+ .expect("successful node creation");
 
  // Node<NodeType::ZERO_COPY>::list(
  // Config{}, [](auto) { return iox::ok(CallbackProgression::Continue);

iceoryx2-ffi/cxx/CMakeLists.txt

@@ -38,6 +38,7 @@ target_include_directories(includes-only-cxx
 add_library(iceoryx2-cxx-object-lib OBJECT
  src/dummy.cpp
  src/node.cpp
+ src/node_name.cpp
 )
 
 set_target_properties(iceoryx2-cxx-object-lib

iceoryx2-ffi/cxx/include/iox2/internal/iceoryx2.hpp

@@ -0,0 +1,19 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+#ifndef IOX2_INTERNAL_ICEORYX2_HPP_
+#define IOX2_INTERNAL_ICEORYX2_HPP_
+
+extern "C" {
+#include <iox2/iceoryx2.h>
+}
+
+#endif

iceoryx2-ffi/cxx/include/iox2/node.hpp

@@ -12,22 +12,21 @@
 #ifndef IOX2_NODE_HPP_
 #define IOX2_NODE_HPP_
 
-#include <iox2/iceoryx2.h>
-
 #include <iox/builder.hpp>
 #include <iox/expected.hpp>
 #include <iox/function.hpp>
 #include <iox/optional.hpp>
-#include <string>
+
+#include "internal/iceoryx2.hpp"
+#include "node_name.hpp"
 
 namespace iox2 {
-enum class SemanticStringError {};
 
 enum class NodeListFailure {};
 
 enum class CallbackProgression { Continue, Stop };
 
-enum class NodeCreationFailure {};
+enum class NodeCreationFailure { InsufficientPermissions, InternalError };
 
 enum class NodeCleanupFailure {};
 
@@ -36,18 +35,6 @@ enum class NodeType { PROCESS_LOCAL, ZERO_COPY };
 class Config {};
 
 class NodeId {};
-
-class NodeName {
- public:
- static iox::expected<NodeName, SemanticStringError> create(
- const char* value);
-
- const std::string& as_string() const;
-
- private:
- iox2_node_name_storage_t value;
-};
-
 class ServiceName {
  public:
  static iox::expected<ServiceName, SemanticStringError> create(
@@ -99,6 +86,11 @@ class Node {
  iox::expected<NodeState<T>, NodeListFailure>)>& callback);
 
  private:
+ friend class NodeBuilder;
+
+ Node(iox2_node_h handle);
+
+ iox2_node_h m_handle;
 };
 
 class NodeBuilder {

iceoryx2-ffi/cxx/include/iox2/node_name.hpp

@@ -0,0 +1,34 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+#ifndef IOX2_NODE_NAME_HPP_
+#define IOX2_NODE_NAME_HPP_
+
+#include <string>
+
+#include "internal/iceoryx2.hpp"
+#include "iox/expected.hpp"
+#include "semantic_string.hpp"
+
+namespace iox2 {
+class NodeName {
+ public:
+ static iox::expected<NodeName, SemanticStringError> create(
+ const char* value);
+
+ const std::string& as_string() const;
+
+ private:
+ iox2_node_name_storage_t value;
+};
+} // namespace iox2
+
+#endif

iceoryx2-ffi/cxx/include/iox2/semantic_string.hpp

@@ -0,0 +1,20 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+#ifndef IOX2_SEMANTIC_STRING_HPP_
+#define IOX2_SEMANTIC_STRING_HPP_
+
+namespace iox2 {
+enum class SemanticStringError {};
+}
+
+#endif

iceoryx2-ffi/cxx/src/node.cpp

@@ -14,14 +14,49 @@
 
 #include <iox2/iceoryx2.h>
 
-namespace iox2 {
-iox::expected<NodeName, SemanticStringError> NodeName::create(
- const char* value) {}
+#include "iox/into.hpp"
+
+namespace iox {
+using namespace ::iox2;
+template <>
+constexpr NodeCreationFailure
+from<iox2_node_creation_failure_e, NodeCreationFailure>(
+ iox2_node_creation_failure_e e) noexcept {
+ switch (e) {
+ case iox2_node_creation_failure_e::
+ iox2_node_creation_failure_e_INSUFFICIENT_PERMISSIONS:
+ return NodeCreationFailure::InsufficientPermissions;
+ case iox2_node_creation_failure_e::
+ iox2_node_creation_failure_e_INTERNAL_ERROR:
+ return NodeCreationFailure::InternalError;
+ }
+}
+} // namespace iox
 
-const std::string& NodeName::as_string() const {}
+namespace iox2 {
+template <NodeType T>
+Node<T>::Node(iox2_node_h handle) : m_handle{handle} {}
 
 NodeBuilder::NodeBuilder() : m_handle{iox2_node_builder_new(nullptr)} {}
 
 template <NodeType T>
-iox::expected<Node<T>, NodeCreationFailure> NodeBuilder::create() const&& {}
+iox::expected<Node<T>, NodeCreationFailure> NodeBuilder::create() const&& {
+ iox2_node_h node_handle;
+ int ret_val = iox2_node_builder_create(
+ m_handle, nullptr, iox2_node_type_e_ZERO_COPY, &node_handle);
+
+ if (ret_val != IOX2_OK) {
+ return iox::err(
+ iox::from<iox2_node_creation_failure_e, NodeCreationFailure>(
+ static_cast<iox2_node_creation_failure_e>(ret_val)));
+ }
+
+ return iox::ok(Node<T>(node_handle));
+}
+
+template iox::expected<Node<NodeType::ZERO_COPY>, NodeCreationFailure>
+NodeBuilder::create() const&&;
+
+template iox::expected<Node<NodeType::PROCESS_LOCAL>, NodeCreationFailure>
+NodeBuilder::create() const&&;
 } // namespace iox2

iceoryx2-ffi/cxx/src/node_name.cpp

@@ -0,0 +1,21 @@
+// Copyright (c) 2024 Contributors to the Eclipse Foundation
+//
+// See the NOTICE file(s) distributed with this work for additional
+// information regarding copyright ownership.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Apache Software License 2.0 which is available at
+// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
+// which is available at https://opensource.org/licenses/MIT.
+//
+// SPDX-License-Identifier: Apache-2.0 OR MIT
+
+#include "iox2/node_name.hpp"
+
+namespace iox2 {
+iox::expected<NodeName, SemanticStringError> NodeName::create(
+ const char* value) {}
+
+const std::string& NodeName::as_string() const {}
+
+} // namespace iox2

iceoryx2-ffi/ffi/src/node_builder.rs

@@ -161,6 +161,11 @@ pub extern "C" fn iox2_node_builder_set_config(node_builder_handle: iox2_node_bu
  // IOX2_OK
 }
 
+#[no_mangle]
+pub extern "C" fn iox2_internal_node_creation_failure_e() -> iox2_node_creation_failure_e {
+ unimplemented!()
+}
+
 /// Creates a node and consumes the builder
 ///
 /// # Arguments