Class astutedds::routing::TopicRoute

ClassList > astutedds > routing > TopicRoute

Bridges a single topic between two DomainParticipants. More...

• #include <topic_route.hpp>

Public Functions

Type	Name
	TopicRoute (const TopicRouteConfig & cfg, dcps::DomainParticipant * input_participant, dcps::DomainParticipant * output_participant) Construct a TopicRoute .
	TopicRoute (const TopicRoute &) = delete
	TopicRoute (TopicRoute &&) = delete
const TopicRouteConfig &	config () const
bool	is_running () const
TopicRoute &	operator= (const TopicRoute &) = delete
TopicRoute &	operator= (TopicRoute &&) = delete
uint64_t	samples_dropped () const Number of samples dropped (by transform or filter) since start() .
uint64_t	samples_routed () const Number of samples successfully forwarded since start() .
void	set_transform (std::unique_ptr< TransformPlugin > plugin) Attach a transform plugin. Must be called before start() .
bool	start () Create DDS entities and begin forwarding samples.
void	stop () Detach callbacks and destroy DDS entities.
	~TopicRoute ()

Detailed Description

Lifecycle: construct → start() → (running) → stop() → destroyed. After stop() the object may be destroyed; calling start() again is not supported.

Public Functions Documentation

function TopicRoute [1/3]

Construct a TopicRoute .

astutedds::routing::TopicRoute::TopicRoute (
    const TopicRouteConfig & cfg,
    dcps::DomainParticipant * input_participant,
    dcps::DomainParticipant * output_participant
) 

The caller (DomainRoute) owns both participant pointers and must ensure they outlive this object.

Parameters:

• cfg Configuration from XML or programmatic setup.
• input_participant DomainParticipant for the source domain.
• output_participant DomainParticipant for the destination domain.

---

function TopicRoute [2/3]

astutedds::routing::TopicRoute::TopicRoute (
    const TopicRoute &
) = delete

---

function TopicRoute [3/3]

astutedds::routing::TopicRoute::TopicRoute (
    TopicRoute &&
) = delete

---

function config

inline const TopicRouteConfig & astutedds::routing::TopicRoute::config () const

---

function is_running

inline bool astutedds::routing::TopicRoute::is_running () const

---

function operator=

TopicRoute & astutedds::routing::TopicRoute::operator= (
    const TopicRoute &
) = delete

---

function operator=

TopicRoute & astutedds::routing::TopicRoute::operator= (
    TopicRoute &&
) = delete

---

function samples_dropped

Number of samples dropped (by transform or filter) since start() .

inline uint64_t astutedds::routing::TopicRoute::samples_dropped () const

---

function samples_routed

Number of samples successfully forwarded since start() .

inline uint64_t astutedds::routing::TopicRoute::samples_routed () const

---

function set_transform

Attach a transform plugin. Must be called before start() .

void astutedds::routing::TopicRoute::set_transform (
    std::unique_ptr< TransformPlugin > plugin
) 

---

function start

Create DDS entities and begin forwarding samples.

bool astutedds::routing::TopicRoute::start () 

Returns:

true on success.

---

function stop

Detach callbacks and destroy DDS entities.

void astutedds::routing::TopicRoute::stop () 

---

function ~TopicRoute

astutedds::routing::TopicRoute::~TopicRoute () 

---

---

The documentation for this class was generated from the following file include/astutedds/routing/topic_route.hpp