#include <port_factory_subscriber.hpp>

Public Member Functions
auto	buffer_size (const uint64_t value) -> decltype(auto)
	Defines the required buffer size of the [`Subscriber`]. Smallest possible value is `1`.

	PortFactorySubscriber (const PortFactorySubscriber &)=delete

	PortFactorySubscriber (PortFactorySubscriber &&)=default

auto	operator= (const PortFactorySubscriber &) -> PortFactorySubscriber &=delete

auto	operator= (PortFactorySubscriber &&) -> PortFactorySubscriber &=default

	~PortFactorySubscriber ()=default

auto	set_degradation_handler (DegradationHandler *handler) &&-> PortFactorySubscriber &&

auto	create () &&-> bb::Expected< Subscriber< S, Payload, UserHeader >, SubscriberCreateError >
	Creates a new [`Subscriber`] or returns a [`SubscriberCreateError`] on failure.

Friends
template<ServiceType , typename , typename >
class	PortFactoryPublishSubscribe

Detailed Description

template<ServiceType S, typename Payload, typename UserHeader>
class iox2::PortFactorySubscriber< S, Payload, UserHeader >

Factory to create a new [Subscriber] port/endpoint for [MessagingPattern::PublishSubscribe] based communication.

Definition at line 30 of file port_factory_subscriber.hpp.

Constructor & Destructor Documentation

◆ PortFactorySubscriber() [1/2]

template<ServiceType S, typename Payload , typename UserHeader >

iox2::PortFactorySubscriber< S, Payload, UserHeader >::PortFactorySubscriber ( const PortFactorySubscriber< S, Payload, UserHeader > & )

delete

◆ PortFactorySubscriber() [2/2]

template<ServiceType S, typename Payload , typename UserHeader >

iox2::PortFactorySubscriber< S, Payload, UserHeader >::PortFactorySubscriber ( PortFactorySubscriber< S, Payload, UserHeader > && )

default

◆ ~PortFactorySubscriber()

template<ServiceType S, typename Payload , typename UserHeader >

iox2::PortFactorySubscriber< S, Payload, UserHeader >::~PortFactorySubscriber ( )

default

Member Function Documentation

◆ buffer_size()

template<ServiceType S, typename Payload , typename UserHeader >

auto iox2::PortFactorySubscriber< S, Payload, UserHeader >::buffer_size ( const uint64_t value ) -> decltype(auto)

Defines the required buffer size of the [Subscriber]. Smallest possible value is 1.

◆ create()

template<ServiceType S, typename Payload , typename UserHeader >

auto iox2::PortFactorySubscriber< S, Payload, UserHeader >::create ( ) && -> bb::Expected<Subscriber<S, Payload, UserHeader>, SubscriberCreateError>

inline

Creates a new [Subscriber] or returns a [SubscriberCreateError] on failure.

Definition at line 82 of file port_factory_subscriber.hpp.

References iox2::detail::degradation_handler_delegate(), and iox2::bb::err().

◆ operator=() [1/2]

template<ServiceType S, typename Payload , typename UserHeader >

auto iox2::PortFactorySubscriber< S, Payload, UserHeader >::operator= ( const PortFactorySubscriber< S, Payload, UserHeader > & ) -> PortFactorySubscriber &=delete

delete

◆ operator=() [2/2]

template<ServiceType S, typename Payload , typename UserHeader >

auto iox2::PortFactorySubscriber< S, Payload, UserHeader >::operator= ( PortFactorySubscriber< S, Payload, UserHeader > && ) -> PortFactorySubscriber &=default

default

◆ set_degradation_handler()

template<ServiceType S, typename Payload , typename UserHeader >

auto iox2::PortFactorySubscriber< S, Payload, UserHeader >::set_degradation_handler ( DegradationHandler * handler ) && -> PortFactorySubscriber&&

inline

Sets the [DegradationHandler] of the [Subscriber]. Whenever a connection to a [Publisher] is corrupted, this handler is called and depending on the returned [DegradationAction] measures will be taken.

Attention: The handler function needs to live as long as the generated subscriber. If the [Subscriber], including the receive function, is accessed from multiple threads, the handler must be thread-safe if it captures data

Definition at line 74 of file port_factory_subscriber.hpp.