iox2::BackpressureInfo Class Reference

The info passed to the [BackpressureHandler]. More...

#include <backpressure_handler.hpp>

Public Member Functions
auto	service_id () const -> RawIdType
	Returns the ServiceId of the involved ports.
auto	receiver_port_id () const -> RawIdType
	Returns the ReceiverPortId of the involved ports.
auto	sender_port_id () const -> RawIdType
	Returns the ReceiverPortId of the involved ports.
auto	retries () const -> uint64_t
	Returns the number retries for the running delivery to the receiver port.
auto	elapsed_time () const -> bb::Duration
	Returns the elapsed time since the initial retry.

Friends
auto	iox2::detail::backpressure_handler_delegate (iox2_backpressure_info_h_ref info_handle, iox2_callback_context callback_cxt) -> iox2_backpressure_action_e

Detailed Description

The info passed to the [BackpressureHandler].

Definition at line 30 of file backpressure_handler.hpp.

Member Function Documentation

elapsed_time()

auto iox2::BackpressureInfo::elapsed_time ( ) const -> bb::Duration

inline

Returns the elapsed time since the initial retry.

Definition at line 69 of file backpressure_handler.hpp.

References iox2::bb::Duration::create_duration().

receiver_port_id()

auto iox2::BackpressureInfo::receiver_port_id ( ) const -> RawIdType

inline

Returns the ReceiverPortId of the involved ports.

Definition at line 53 of file backpressure_handler.hpp.

References iox2::bb::StaticVector< T, Capacity >::from_range_unchecked().

retries()

auto iox2::BackpressureInfo::retries ( ) const -> uint64_t

inline

Returns the number retries for the running delivery to the receiver port.

Definition at line 65 of file backpressure_handler.hpp.

sender_port_id()

auto iox2::BackpressureInfo::sender_port_id ( ) const -> RawIdType

inline

Returns the ReceiverPortId of the involved ports.

Definition at line 59 of file backpressure_handler.hpp.

References iox2::bb::StaticVector< T, Capacity >::from_range_unchecked().

service_id()

auto iox2::BackpressureInfo::service_id ( ) const -> RawIdType

inline

Returns the ServiceId of the involved ports.

Definition at line 47 of file backpressure_handler.hpp.

References iox2::bb::StaticVector< T, Capacity >::from_range_unchecked().

Friends And Related Symbol Documentation

iox2::detail::backpressure_handler_delegate

auto iox2::detail::backpressure_handler_delegate ( iox2_backpressure_info_h_ref  info_handle, iox2_callback_context  callback_cxt  ) -> iox2_backpressure_action_e

friend

---

The documentation for this class was generated from the following file:

• iox2/backpressure_handler.hpp