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_WRITER_HPP
#define IOX2_WRITER_HPP
 
#include "iox2/bb/expected.hpp"
#include "iox2/entry_handle_mut.hpp"
#include "iox2/entry_handle_mut_error.hpp"
#include "iox2/internal/service_builder_internal.hpp"
#include "iox2/port_name.hpp"
#include "iox2/service_type.hpp"
#include "iox2/unique_port_id.hpp"
 
namespace iox2 {
template <ServiceType S, typename KeyType>
class Writer {
  public:
    Writer(Writer&& rhs) noexcept;
    auto operator=(Writer&& rhs) noexcept -> Writer&;
    ~Writer();
 
    Writer(const Writer&) = delete;
    auto operator=(const Writer&) -> Writer& = delete;
 
    auto id() const -> UniqueWriterId;
 
    auto name() const -> PortNameView;
 
    template <typename ValueType>
    auto entry(const KeyType& key) -> bb::Expected<EntryHandleMut<S, KeyType, ValueType>, EntryHandleMutError>;
 
  private:
    template <ServiceType, typename>
    friend class PortFactoryWriter;
 
    explicit Writer(iox2_writer_h handle);
    void drop();
 
    iox2_writer_h m_handle = nullptr;
};
 
template <ServiceType S, typename KeyType>
inline Writer<S, KeyType>::Writer(iox2_writer_h handle)
    : m_handle { handle } {
}
 
template <ServiceType S, typename KeyType>
inline void Writer<S, KeyType>::drop() {
    if (m_handle != nullptr) {
        iox2_writer_drop(m_handle);
        m_handle = nullptr;
    }
}
 
template <ServiceType S, typename KeyType>
inline Writer<S, KeyType>::Writer(Writer&& rhs) noexcept {
    *this = std::move(rhs);
}
 
template <ServiceType S, typename KeyType>
inline auto Writer<S, KeyType>::operator=(Writer&& rhs) noexcept -> Writer& {
    if (this != &rhs) {
        drop();
        m_handle = rhs.m_handle;
        rhs.m_handle = nullptr;
    }
 
    return *this;
}
 
template <ServiceType S, typename KeyType>
inline Writer<S, KeyType>::~Writer() {
    drop();
}
 
template <ServiceType S, typename KeyType>
inline auto Writer<S, KeyType>::id() const -> UniqueWriterId {
    iox2_unique_writer_id_h id_handle = nullptr;
 
    iox2_writer_id(&m_handle, nullptr, &id_handle);
    return UniqueWriterId { id_handle };
}
 
template <ServiceType S, typename KeyType>
inline auto Writer<S, KeyType>::name() const -> PortNameView {
    const auto* port_name_ptr = iox2_writer_name(&m_handle);
    return PortNameView::from_native_ptr(port_name_ptr);
}
 
template <ServiceType S, typename KeyType>
template <typename ValueType>
inline auto Writer<S, KeyType>::entry(const KeyType& key)
    -> bb::Expected<EntryHandleMut<S, KeyType, ValueType>, EntryHandleMutError> {
    iox2_entry_handle_mut_h entry_handle {};
    const auto type_name = internal::get_type_name<ValueType>();
 
    auto result = iox2_writer_entry(&m_handle,
                                    nullptr,
                                    &entry_handle,
                                    &key,
                                    type_name.unchecked_access().c_str(),
                                    type_name.size(),
                                    sizeof(ValueType),
                                    alignof(ValueType));
 
    if (result == IOX2_OK) {
        return EntryHandleMut<S, KeyType, ValueType>(entry_handle);
    }
 
    return bb::err(bb::into<EntryHandleMutError>(result));
}
} // namespace iox2
 
#endif