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_SUBSCRIBER_HPP
#define IOX2_SUBSCRIBER_HPP
 
#include "iox2/bb/expected.hpp"
#include "iox2/bb/optional.hpp"
#include "iox2/connection_failure.hpp"
#include "iox2/iceoryx2.h"
#include "iox2/internal/iceoryx2.hpp"
#include "iox2/port_name.hpp"
#include "iox2/sample.hpp"
#include "iox2/service_type.hpp"
#include "iox2/subscriber_error.hpp"
#include "iox2/unique_port_id.hpp"
 
namespace iox2 {
template <ServiceType S, typename Payload, typename UserHeader>
class Subscriber {
  public:
    Subscriber(Subscriber&& rhs) noexcept;
    auto operator=(Subscriber&& rhs) noexcept -> Subscriber&;
    ~Subscriber();
 
    Subscriber(const Subscriber&) = delete;
    auto operator=(const Subscriber&) -> Subscriber& = delete;
 
    auto id() const -> UniqueSubscriberId;
 
    auto name() const -> PortNameView;
 
    auto buffer_size() const -> uint64_t;
 
    auto receive() const -> bb::Expected<bb::Optional<Sample<S, Payload, UserHeader>>, ReceiveError>;
 
    auto has_samples() const -> bb::Expected<bool, ConnectionFailure>;
 
  private:
    template <ServiceType, typename, typename>
    friend class PortFactorySubscriber;
 
    explicit Subscriber(iox2_subscriber_h handle);
    void drop();
 
    iox2_subscriber_h m_handle = nullptr;
};
template <ServiceType S, typename Payload, typename UserHeader>
inline Subscriber<S, Payload, UserHeader>::Subscriber(iox2_subscriber_h handle)
    : m_handle { handle } {
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline Subscriber<S, Payload, UserHeader>::Subscriber(Subscriber&& rhs) noexcept {
    *this = std::move(rhs);
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline auto Subscriber<S, Payload, UserHeader>::operator=(Subscriber&& rhs) noexcept -> Subscriber& {
    if (this != &rhs) {
        drop();
        m_handle = rhs.m_handle;
        rhs.m_handle = nullptr;
    }
 
    return *this;
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline Subscriber<S, Payload, UserHeader>::~Subscriber() {
    drop();
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline void Subscriber<S, Payload, UserHeader>::drop() {
    if (m_handle != nullptr) {
        iox2_subscriber_drop(m_handle);
        m_handle = nullptr;
    }
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline auto Subscriber<S, Payload, UserHeader>::has_samples() const -> bb::Expected<bool, ConnectionFailure> {
    bool has_samples_result = false;
    auto result = iox2_subscriber_has_samples(&m_handle, &has_samples_result);
 
    if (result == IOX2_OK) {
        return has_samples_result;
    }
 
    return bb::err(bb::into<ConnectionFailure>(result));
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline auto Subscriber<S, Payload, UserHeader>::id() const -> UniqueSubscriberId {
    iox2_unique_subscriber_id_h id_handle = nullptr;
 
    iox2_subscriber_id(&m_handle, nullptr, &id_handle);
    return UniqueSubscriberId { id_handle };
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline auto Subscriber<S, Payload, UserHeader>::name() const -> PortNameView {
    const auto* port_name_ptr = iox2_subscriber_name(&m_handle);
    return PortNameView::from_native_ptr(port_name_ptr);
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline auto Subscriber<S, Payload, UserHeader>::buffer_size() const -> uint64_t {
    return iox2_subscriber_buffer_size(&m_handle);
}
 
template <ServiceType S, typename Payload, typename UserHeader>
inline auto Subscriber<S, Payload, UserHeader>::receive() const
    -> bb::Expected<bb::Optional<Sample<S, Payload, UserHeader>>, ReceiveError> {
    Sample<S, Payload, UserHeader> sample;
    auto result = iox2_subscriber_receive(&m_handle, &sample.m_sample, &sample.m_handle);
 
    if (result == IOX2_OK) {
        if (sample.m_handle != nullptr) {
            return bb::Optional<Sample<S, Payload, UserHeader>>(std::move(sample));
        }
        return bb::Optional<Sample<S, Payload, UserHeader>>(bb::NULLOPT);
    }
 
    return bb::err(bb::into<ReceiveError>(result));
}
} // namespace iox2
 
#endif