node_state.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_STATE_HPP
#define IOX2_NODE_STATE_HPP
 
#include "iox2/bb/expected.hpp"
#include "iox2/bb/optional.hpp"
#include "iox2/bb/static_function.hpp"
#include "iox2/legacy/variant.hpp"
#include "node_details.hpp"
#include "node_failure_enums.hpp"
#include "service_type.hpp"
#include "unique_node_id.hpp"
 
namespace iox2 {
template <ServiceType>
class AliveNodeView {
  public:
    AliveNodeView(const AliveNodeView&) = default;
    AliveNodeView(AliveNodeView&&) = default;
    auto operator=(const AliveNodeView&) -> AliveNodeView& = default;
    auto operator=(AliveNodeView&&) -> AliveNodeView& = default;
    ~AliveNodeView() = default;
 
    AliveNodeView(UniqueNodeId node_id, const bb::Optional<NodeDetails>& details);
 
    auto id() const -> const UniqueNodeId&;
 
    auto details() const -> const bb::Optional<NodeDetails>&;
 
  private:
    UniqueNodeId m_id;
    bb::Optional<NodeDetails> m_details;
};
 
template <ServiceType T>
class DeadNodeView {
  public:
    DeadNodeView(const DeadNodeView&) = default;
    DeadNodeView(DeadNodeView&&) = default;
    auto operator=(const DeadNodeView&) -> DeadNodeView& = default;
    auto operator=(DeadNodeView&&) -> DeadNodeView& = default;
    ~DeadNodeView() = default;
 
    explicit DeadNodeView(const AliveNodeView<T>& view);
 
    auto id() const -> const UniqueNodeId&;
 
    auto details() const -> bb::Optional<NodeDetails>;
 
    auto try_remove_stale_resources() -> iox2::bb::Expected<void, NodeCleanupFailure>;
 
    auto blocking_remove_stale_resources(iox2::bb::Duration timeout) -> iox2::bb::Expected<void, NodeCleanupFailure>;
 
  private:
    AliveNodeView<T> m_view;
};
 
template <ServiceType T>
class NodeState {
  public:
    NodeState(const NodeState&) = default;
    NodeState(NodeState&&) = default;
    auto operator=(const NodeState&) -> NodeState& = default;
    auto operator=(NodeState&&) -> NodeState& = default;
    ~NodeState() = default;
 
    auto alive(const iox2::bb::StaticFunction<void(AliveNodeView<T>&)>& callback) -> NodeState&;
 
    auto dead(const iox2::bb::StaticFunction<void(DeadNodeView<T>&)>& callback) -> NodeState&;
 
    auto inaccessible(const iox2::bb::StaticFunction<void(UniqueNodeId&)>& callback) -> NodeState&;
 
    auto undefined(const iox2::bb::StaticFunction<void(UniqueNodeId&)>& callback) -> NodeState&;
 
  private:
    template <ServiceType>
    friend auto internal::list_callback(iox2_node_state_e,
                                        iox2_unique_node_id_ptr,
                                        const char*,
                                        iox2_node_name_ptr,
                                        iox2_config_ptr,
                                        iox2_callback_context) -> iox2_callback_progression_e;
 
    explicit NodeState(const AliveNodeView<T>& view);
    explicit NodeState(const DeadNodeView<T>& view);
    NodeState(iox2_node_state_e node_state, const UniqueNodeId& node_id);
 
    iox2::legacy::variant<AliveNodeView<T>, DeadNodeView<T>, UniqueNodeId, UniqueNodeId> m_state;
};
} // namespace iox2
 
#endif