port_factory_event.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_PORTFACTORY_EVENT_HPP
#define IOX2_PORTFACTORY_EVENT_HPP
 
#include "iox2/attribute_set.hpp"
#include "iox2/bb/expected.hpp"
#include "iox2/bb/static_function.hpp"
#include "iox2/callback_progression.hpp"
#include "iox2/cleanup_state.hpp"
#include "iox2/dynamic_config_event.hpp"
#include "iox2/internal/iceoryx2.hpp"
#include "iox2/node_failure_enums.hpp"
#include "iox2/node_state.hpp"
#include "iox2/port_factory_listener.hpp"
#include "iox2/port_factory_notifier.hpp"
#include "iox2/service_hash.hpp"
#include "iox2/service_name.hpp"
#include "iox2/service_type.hpp"
#include "iox2/static_config_event.hpp"
 
namespace iox2 {
template <ServiceType S>
class PortFactoryEvent {
  public:
    PortFactoryEvent(PortFactoryEvent&&) noexcept;
    auto operator=(PortFactoryEvent&&) noexcept -> PortFactoryEvent&;
    ~PortFactoryEvent();
 
    PortFactoryEvent(const PortFactoryEvent&) = delete;
    auto operator=(const PortFactoryEvent&) -> PortFactoryEvent& = delete;
 
    auto name() const -> ServiceNameView;
 
    auto service_hash() const -> ServiceHash;
 
    auto attributes() const -> AttributeSetView;
 
    auto static_config() const -> StaticConfigEvent;
 
    auto dynamic_config() const -> DynamicConfigEvent;
 
    auto nodes(const iox2::bb::StaticFunction<CallbackProgression(NodeState<S>)>& callback) const
        -> bb::Expected<void, NodeListFailure>;
 
    auto listener_builder() const -> PortFactoryListener<S>;
 
    auto notifier_builder() const -> PortFactoryNotifier<S>;
 
    auto try_cleanup_dead_nodes() const -> CleanupState;
 
    auto blocking_cleanup_dead_nodes(iox2::bb::Duration timeout) const -> CleanupState;
 
  private:
    template <ServiceType>
    friend class ServiceBuilderEvent;
 
    explicit PortFactoryEvent(iox2_port_factory_event_h handle);
    void drop() noexcept;
 
    iox2_port_factory_event_h m_handle = nullptr;
};
} // namespace iox2
 
#endif