Class astutedds::routing::RoutingService

ClassList > astutedds > routing > RoutingService

Top-level DDS routing service managing one or more DomainRoutes. More...

  • #include <routing_service.hpp>

Public Functions

Type Name
RoutingService (const RoutingServiceConfig & cfg)
Construct from a fully populated RoutingServiceConfig .
RoutingService (const RoutingService &) = delete
RoutingService (RoutingService &&) = delete
const RoutingServiceConfig & config () const
const std::vector< std::unique_ptr< DomainRoute > > & domain_routes () const
Read-only access to running DomainRoutes (e.g. for statistics).
bool is_running () const
RoutingService & operator= (const RoutingService &) = delete
RoutingService & operator= (RoutingService &&) = delete
bool start ()
Start all DomainRoutes.
void stop ()
Stop all DomainRoutes and release DDS resources.
~RoutingService ()

Detailed Description

Lifecycle: construct → start() → (running) → stop().

Public Functions Documentation

function RoutingService [1/3]

Construct from a fully populated RoutingServiceConfig .

explicit astutedds::routing::RoutingService::RoutingService (
    const RoutingServiceConfig & cfg
) 


function RoutingService [2/3]

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

function RoutingService [3/3]

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

function config

inline const RoutingServiceConfig & astutedds::routing::RoutingService::config () const

function domain_routes

Read-only access to running DomainRoutes (e.g. for statistics).

inline const std::vector< std::unique_ptr< DomainRoute > > & astutedds::routing::RoutingService::domain_routes () const


function is_running

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

function operator=

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

function operator=

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

function start

Start all DomainRoutes.

bool astutedds::routing::RoutingService::start () 

Returns:

true if every DomainRoute started successfully.


function stop

Stop all DomainRoutes and release DDS resources.

void astutedds::routing::RoutingService::stop () 


function ~RoutingService

astutedds::routing::RoutingService::~RoutingService () 


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