Safe DDS
eprosima::safedds::discovery::ILocatorObserver Interface Referenceabstract

ILocatorObserver interface. More...

#include <ILocatorObserver.hpp>

Public Member Functions

virtual void on_locator_discovered (const protocol::GUID &guid, bool is_metatraffic, const transport::Locator &locator, const protocol::GUIDPrefix &discoverer) noexcept=0
 callback on new locator discovered. More...
 
virtual void on_group_discovered (const protocol::EndpointGroup &group, bool is_metatraffic, const transport::Locator &locator, const protocol::GUIDPrefix &discoverer) noexcept=0
 callback on new group discovered. More...
 
virtual void on_locators_unregistered (const protocol::GUID &guid, const protocol::GUIDPrefix &discoverer) noexcept=0
 callback on locator not required anymore. More...
 
virtual void on_group_unregistered (const protocol::EndpointGroup &group, const protocol::GUIDPrefix &discoverer) noexcept=0
 callback on group not required anymore. More...
 
virtual protocol::EndpointGroup get_group (const transport::Locator &locator) const noexcept=0
 Get the Endpoint Group for a given locator. More...
 

Protected Member Functions

 ~ILocatorObserver () noexcept=default
 Protected destructor ownership defined on creation. More...
 
 ILocatorObserver () noexcept=default
 Default creation. More...
 
 ILocatorObserver (const ILocatorObserver &) noexcept=delete
 Copy deleted. More...
 
 ILocatorObserver (ILocatorObserver &&) noexcept=delete
 Movement deleted. More...
 
ILocatorObserveroperator= (const ILocatorObserver &) noexcept=delete
 Copy operator deleted. More...
 
ILocatorObserveroperator= (ILocatorObserver &&) noexcept=delete
 Movement operator deleted. More...
 

Detailed Description

ILocatorObserver interface.

Constructor & Destructor Documentation

◆ ~ILocatorObserver()

eprosima::safedds::discovery::ILocatorObserver::~ILocatorObserver ( )
protecteddefaultnoexcept

Protected destructor ownership defined on creation.

◆ ILocatorObserver() [1/3]

eprosima::safedds::discovery::ILocatorObserver::ILocatorObserver ( )
protecteddefaultnoexcept

Default creation.

◆ ILocatorObserver() [2/3]

eprosima::safedds::discovery::ILocatorObserver::ILocatorObserver ( const ILocatorObserver )
protecteddeletenoexcept

Copy deleted.

◆ ILocatorObserver() [3/3]

eprosima::safedds::discovery::ILocatorObserver::ILocatorObserver ( ILocatorObserver &&  )
protecteddeletenoexcept

Movement deleted.

Member Function Documentation

◆ get_group()

virtual protocol::EndpointGroup eprosima::safedds::discovery::ILocatorObserver::get_group ( const transport::Locator locator) const
pure virtualnoexcept

Get the Endpoint Group for a given locator.

Parameters
locatorLocator to get the group for.
Returns
protocol::EndpointGroup: Endpoint Group associated with the locator.

Implemented in eprosima::safedds::transport::posix::UDPv4.

◆ on_group_discovered()

virtual void eprosima::safedds::discovery::ILocatorObserver::on_group_discovered ( const protocol::EndpointGroup group,
bool  is_metatraffic,
const transport::Locator locator,
const protocol::GUIDPrefix discoverer 
)
pure virtualnoexcept

callback on new group discovered.

Parameters
groupGroup ID.
is_metatrafficIs metatraffic.
locatorDiscovered locator.
discovererGUIDPrefix of the entity that discovered the locator.

Implemented in eprosima::safedds::transport::posix::UDPv4.

◆ on_group_unregistered()

virtual void eprosima::safedds::discovery::ILocatorObserver::on_group_unregistered ( const protocol::EndpointGroup group,
const protocol::GUIDPrefix discoverer 
)
pure virtualnoexcept

callback on group not required anymore.

Parameters
groupGroup ID.
discovererGUIDPrefix of the entity that discovered the locator.

Implemented in eprosima::safedds::transport::posix::UDPv4.

◆ on_locator_discovered()

virtual void eprosima::safedds::discovery::ILocatorObserver::on_locator_discovered ( const protocol::GUID guid,
bool  is_metatraffic,
const transport::Locator locator,
const protocol::GUIDPrefix discoverer 
)
pure virtualnoexcept

callback on new locator discovered.

Parameters
guidEntity GUID.
is_metatrafficIs metatraffic.
locatorDiscovered locator.
discovererGUIDPrefix of the entity that discovered the locator.

Implemented in eprosima::safedds::transport::posix::UDPv4.

◆ on_locators_unregistered()

virtual void eprosima::safedds::discovery::ILocatorObserver::on_locators_unregistered ( const protocol::GUID guid,
const protocol::GUIDPrefix discoverer 
)
pure virtualnoexcept

callback on locator not required anymore.

Parameters
guidEntity GUID.
discovererGUIDPrefix of the entity that discovered the locator.

Implemented in eprosima::safedds::transport::posix::UDPv4.

◆ operator=() [1/2]

ILocatorObserver& eprosima::safedds::discovery::ILocatorObserver::operator= ( const ILocatorObserver )
protecteddeletenoexcept

Copy operator deleted.

◆ operator=() [2/2]

ILocatorObserver& eprosima::safedds::discovery::ILocatorObserver::operator= ( ILocatorObserver &&  )
protecteddeletenoexcept

Movement operator deleted.


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