backpressure_handler.hpp

Go to the documentation of this file.

// Copyright (c) 2026 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_BACKPRESSURE_HANDLER_HPP
#define IOX2_BACKPRESSURE_HANDLER_HPP
 
#include "iox2/backpressure_action.hpp"
#include "iox2/bb/duration.hpp"
#include "iox2/bb/static_function.hpp"
#include "iox2/internal/iceoryx2.hpp"
#include "iox2/unique_port_id.hpp"
 
namespace iox2 {
namespace detail {
// forward declaration in order to make it a friend in BackpressureInfo
inline auto backpressure_handler_delegate(iox2_backpressure_info_h_ref info_handle, iox2_callback_context callback_cxt)
    -> iox2_backpressure_action_e;
} // namespace detail
 
class BackpressureInfo {
  private:
    iox2_backpressure_info_h_ref m_info;
 
    explicit BackpressureInfo(iox2_backpressure_info_h_ref info)
        : m_info(info) {
    }
 
    friend auto iox2::detail::backpressure_handler_delegate(iox2_backpressure_info_h_ref info_handle,
                                                            iox2_callback_context callback_cxt)
        -> iox2_backpressure_action_e;
 
    static_assert(sizeof(iox2_buffer_16_align_4_t::data) == RawIdType::capacity(),
                  "RawIdType capacity must match iox2_buffer_16_align_4_t capacity");
 
  public:
    auto service_id() const -> RawIdType {
        iox2_buffer_16_align_4_t buf;
        iox2_backpressure_info_service_id(m_info, &buf);
        return RawIdType::from_range_unchecked(buf.data).value();
    }
    auto receiver_port_id() const -> RawIdType {
        iox2_buffer_16_align_4_t buf;
        iox2_backpressure_info_receiver_port_id(m_info, &buf);
        return RawIdType::from_range_unchecked(buf.data).value();
    }
    auto sender_port_id() const -> RawIdType {
        iox2_buffer_16_align_4_t buf;
        iox2_backpressure_info_sender_port_id(m_info, &buf);
        return RawIdType::from_range_unchecked(buf.data).value();
    }
    auto retries() const -> uint64_t {
        return iox2_backpressure_info_retries(m_info);
    }
    auto elapsed_time() const -> bb::Duration {
        uint64_t seconds = 0;
        uint32_t nanoseconds = 0;
        iox2_backpressure_info_elapsed_time(m_info, &seconds, &nanoseconds);
        return bb::Duration::create_duration(seconds, nanoseconds);
    }
};
 
using BackpressureHandler = iox2::bb::StaticFunction<BackpressureAction(const BackpressureInfo&)>;
 
namespace detail {
inline auto backpressure_handler_delegate(iox2_backpressure_info_h_ref info_handle, iox2_callback_context callback_cxt)
    -> iox2_backpressure_action_e {
    auto* callback = static_cast<BackpressureHandler*>(callback_cxt);
 
    auto info = BackpressureInfo(info_handle);
 
    return bb::into<iox2_backpressure_action_e>((*callback)(info));
}
} // namespace detail
 
} // namespace iox2
 
#endif // IOX2_BACKPRESSURE_HANDLER_HPP