port_factory_writer.hpp

Go to the documentation of this file.

// Copyright (c) 2025 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_WRITER_HPP
#define IOX2_PORTFACTORY_WRITER_HPP
 
#include "iox2/bb/detail/builder.hpp"
#include "iox2/bb/expected.hpp"
#include "iox2/port_name.hpp"
#include "iox2/service_type.hpp"
#include "iox2/writer.hpp"
#include "iox2/writer_error.hpp"
 
namespace iox2 {
template <ServiceType S, typename KeyType>
class PortFactoryWriter {
  public:
#ifdef DOXYGEN_MACRO_FIX
    auto name(const PortName value) -> decltype(auto);
#else
    IOX2_BUILDER_OPTIONAL(PortName, name);
#endif
 
  public:
    PortFactoryWriter(PortFactoryWriter&&) noexcept = default;
    auto operator=(PortFactoryWriter&&) noexcept -> PortFactoryWriter& = default;
    ~PortFactoryWriter() = default;
 
    PortFactoryWriter(const PortFactoryWriter&) = delete;
    auto operator=(const PortFactoryWriter&) -> PortFactoryWriter& = delete;
 
    auto create() && -> bb::Expected<Writer<S, KeyType>, WriterCreateError>;
 
  private:
    template <ServiceType, typename>
    friend class PortFactoryBlackboard;
 
    explicit PortFactoryWriter(iox2_port_factory_writer_builder_h handle);
 
    iox2_port_factory_writer_builder_h m_handle = nullptr;
};
 
template <ServiceType S, typename KeyType>
inline PortFactoryWriter<S, KeyType>::PortFactoryWriter(iox2_port_factory_writer_builder_h handle)
    : m_handle { handle } {
}
 
template <ServiceType S, typename KeyType>
inline auto PortFactoryWriter<S, KeyType>::create() && -> bb::Expected<Writer<S, KeyType>, WriterCreateError> {
    if (m_name.has_value()) {
        const auto* name_ptr = m_name.value().as_view().native_ptr();
        iox2_port_factory_writer_builder_set_name(&m_handle, name_ptr);
    }
 
    iox2_writer_h writer_handle {};
    auto result = iox2_port_factory_writer_builder_create(m_handle, nullptr, &writer_handle);
 
    if (result == IOX2_OK) {
        return Writer<S, KeyType>(writer_handle);
    }
 
    return bb::err(bb::into<WriterCreateError>(result));
}
} // namespace iox2
 
#endif