node.hpp

Go to the documentation of this file.

// 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_HPP
#define IOX2_NODE_HPP
 
#include "iox2/bb/detail/builder.hpp"
#include "iox2/bb/duration.hpp"
#include "iox2/bb/expected.hpp"
#include "iox2/bb/static_function.hpp"
#include "iox2/callback_progression.hpp"
#include "iox2/cleanup_state.hpp"
#include "iox2/config.hpp"
#include "iox2/internal/iceoryx2.hpp"
#include "iox2/messaging_pattern.hpp"
#include "iox2/node_failure_enums.hpp"
#include "iox2/node_name.hpp"
#include "iox2/node_state.hpp"
#include "iox2/node_wait_failure.hpp"
#include "iox2/service_builder.hpp"
#include "iox2/service_name.hpp"
#include "iox2/service_type.hpp"
#include "iox2/signal_handling_mode.hpp"
#include "iox2/unique_node_id.hpp"
 
namespace iox2 {
template <ServiceType T>
class Node {
  public:
    Node(Node&&) noexcept;
    auto operator=(Node&&) noexcept -> Node&;
    Node(const Node&) = delete;
    auto operator=(const Node&) -> Node& = delete;
    ~Node();
 
    auto config() const -> ConfigView;
 
    auto name() const -> NodeNameView;
 
    auto id() const -> UniqueNodeId;
 
    auto service_builder(const ServiceName& name) const -> ServiceBuilder<T>;
 
    auto wait(iox2::bb::Duration cycle_time) const -> bb::Expected<void, NodeWaitFailure>;
 
    static auto list(ConfigView config, const iox2::bb::StaticFunction<CallbackProgression(NodeState<T>)>& callback)
        -> bb::Expected<void, NodeListFailure>;
 
    auto signal_handling_mode() const -> SignalHandlingMode;
 
    auto try_cleanup_dead_nodes() -> CleanupState;
 
    auto blocking_cleanup_dead_nodes(iox2::bb::Duration timeout) -> CleanupState;
 
    auto force_remove_service(const iox2::ServiceName& name, iox2::MessagingPattern messaging_pattern) const
        -> iox2::bb::Expected<bool, ServiceRemoveError>;
 
  private:
    explicit Node(iox2_node_h handle);
    void drop();
 
    friend class NodeBuilder;
 
    iox2_node_h m_handle = nullptr;
};
 
class NodeBuilder {
  public:
#ifdef DOXYGEN_MACRO_FIX
    auto name(const NodeName value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(NodeName, name);
#endif
 
#ifdef DOXYGEN_MACRO_FIX
    auto config(const Config value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(Config, config);
#endif
 
#ifdef DOXYGEN_MACRO_FIX
    auto signal_handling_mode(const SignalHandlingMode value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(SignalHandlingMode, signal_handling_mode);
#endif
 
  public:
    NodeBuilder();
    NodeBuilder(NodeBuilder&&) = default;
    auto operator=(NodeBuilder&&) -> NodeBuilder& = default;
    ~NodeBuilder() = default;
 
    NodeBuilder(const NodeBuilder&) = delete;
    auto operator=(const NodeBuilder&) -> NodeBuilder& = delete;
 
    template <ServiceType T>
    auto create() const&& -> bb::Expected<Node<T>, NodeCreationFailure>;
 
  private:
    iox2_node_builder_h m_handle = nullptr;
};
} // namespace iox2
 
#endif