iox2::PortFactorySubscriber< S, Payload, UserHeader > Class Template Reference

#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.
auto	history_request (const uint64_t value) -> decltype(auto)
auto	name (const PortName value) -> decltype(auto)
	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 31 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 100 of file port_factory_subscriber.hpp.

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

history_request()

template<ServiceType S, typename Payload , typename UserHeader >

auto iox2::PortFactorySubscriber< S, Payload, UserHeader >::history_request

(

const uint64_t

value

)

-> decltype(auto)

Defines the amount of requested history samples. By default the value defined with the service's history_size is used.

name()

template<ServiceType S, typename Payload , typename UserHeader >

auto iox2::PortFactorySubscriber< S, Payload, UserHeader >::name

(

const PortName

value

)

-> decltype(auto)

The [PortName] that shall be assigned to the [Subscriber]. It does not have to be unique. If no [PortName] is defined then the [Subscriber] does not have a name.

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 92 of file port_factory_subscriber.hpp.

Friends And Related Symbol Documentation

PortFactoryPublishSubscribe

template<ServiceType S, typename Payload , typename UserHeader >

template<ServiceType , typename , typename >

friend class PortFactoryPublishSubscribe

friend

Definition at line 77 of file port_factory_subscriber.hpp.

---

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

• iox2/port_factory_subscriber.hpp