port_factory_subscriber.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_SUBSCRIBER_HPP
#define IOX2_PORTFACTORY_SUBSCRIBER_HPP
 
#include "iox2/bb/detail/builder.hpp"
#include "iox2/bb/expected.hpp"
#include "iox2/degradation_handler.hpp"
#include "iox2/internal/iceoryx2.hpp"
#include "iox2/port_name.hpp"
#include "iox2/service_type.hpp"
#include "iox2/subscriber.hpp"
 
#include <cstdint>
 
namespace iox2 {
 
template <ServiceType S, typename Payload, typename UserHeader>
class PortFactorySubscriber {
  public:
#ifdef DOXYGEN_MACRO_FIX
    auto buffer_size(const uint64_t value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(uint64_t, buffer_size);
#endif
 
#ifdef DOXYGEN_MACRO_FIX
    auto history_request(const uint64_t value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(uint64_t, history_request);
#endif
 
#ifdef DOXYGEN_MACRO_FIX
    auto name(const PortName value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(PortName, name);
#endif
 
  public:
    PortFactorySubscriber(const PortFactorySubscriber&) = delete;
    PortFactorySubscriber(PortFactorySubscriber&&) = default;
    auto operator=(const PortFactorySubscriber&) -> PortFactorySubscriber& = delete;
    auto operator=(PortFactorySubscriber&&) -> PortFactorySubscriber& = default;
    ~PortFactorySubscriber() = default;
 
    auto set_degradation_handler(DegradationHandler* handler) && -> PortFactorySubscriber&&;
 
    auto create() && -> bb::Expected<Subscriber<S, Payload, UserHeader>, SubscriberCreateError>;
 
  private:
    template <ServiceType, typename, typename>
    friend class PortFactoryPublishSubscribe;
 
    explicit PortFactorySubscriber(iox2_port_factory_subscriber_builder_h handle);
 
    iox2_port_factory_subscriber_builder_h m_handle = nullptr;
    bb::Optional<DegradationHandler* const> m_degradation_handler;
};
 
template <ServiceType S, typename Payload, typename UserHeader>
inline PortFactorySubscriber<S, Payload, UserHeader>::PortFactorySubscriber(
    iox2_port_factory_subscriber_builder_h handle)
    : m_handle { handle } {
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline auto PortFactorySubscriber<S, Payload, UserHeader>::set_degradation_handler(
    DegradationHandler* handler) && -> PortFactorySubscriber&& {
    m_degradation_handler.emplace(handler);
    return std::move(*this);
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline auto
PortFactorySubscriber<S, Payload, UserHeader>::create() && -> bb::Expected<Subscriber<S, Payload, UserHeader>,
                                                                           SubscriberCreateError> {
    if (m_buffer_size.has_value()) {
        iox2_port_factory_subscriber_builder_set_buffer_size(&m_handle, m_buffer_size.value());
    }
 
    if (m_history_request.has_value()) {
        iox2_port_factory_subscriber_builder_set_history_request(&m_handle, m_history_request.value());
    }
 
    if (m_degradation_handler.has_value()) {
        iox2_port_factory_subscriber_builder_set_degradation_handler(
            &m_handle, detail::degradation_handler_delegate, static_cast<void*>(m_degradation_handler.value()));
    }
 
    if (m_name.has_value()) {
        const auto* name_ptr = m_name.value().as_view().native_ptr();
        iox2_port_factory_subscriber_builder_set_name(&m_handle, name_ptr);
    }
 
    iox2_subscriber_h sub_handle {};
    auto result = iox2_port_factory_subscriber_builder_create(m_handle, nullptr, &sub_handle);
 
    if (result == IOX2_OK) {
        return Subscriber<S, Payload, UserHeader>(sub_handle);
    }
 
    return bb::err(bb::into<SubscriberCreateError>(result));
}
} // namespace iox2
 
#endif