eprosima::safedds::discovery::IDiscovery Interface Reference

IDiscovery interface. More...

#include <IDiscovery.hpp>

Public Member Functions
virtual ReturnCode	add_local_participant (const ParticipantInfo &participant_info) noexcept=0
	Add local new participant. More...
virtual ReturnCode	add_local_publication (const PublicationInfo &info) noexcept=0
	Add local new publication. More...
virtual ReturnCode	add_local_subscription (const SubscriptionInfo &info) noexcept=0
	Add local new subscription. More...
virtual void	fill_local_participant_builtin_endpoints (discovery::ParticipantInfo &participant_info) const noexcept=0
	Fill local participant builtin endpoints. More...
virtual ReturnCode	decommission_local_participant (const protocol::GUIDPrefix &participant_prefix) noexcept=0
	Decommission local participant. More...
Public Member Functions inherited from eprosima::safedds::execution::ISpinnable
virtual void	spin (const TimePoint &timepoint) noexcept=0
	Secuential synchronization interface. More...
virtual bool	has_pending_work () const noexcept=0
	Check if the entity has pending work. More...
virtual TimePoint	get_next_work_timepoint () const noexcept=0
	Get next work timepoint. More...

Protected Member Functions
	~IDiscovery () noexcept=default
	Protected destructor ownership defined on creation. More...
	IDiscovery () noexcept=default
	Default creation. More...
	IDiscovery (const IDiscovery &) noexcept=delete
	Copy deleted. More...
	IDiscovery (IDiscovery &&) noexcept=delete
	Movement deleted. More...
IDiscovery &	operator= (const IDiscovery &) noexcept=delete
	Copy operator deleted. More...
IDiscovery &	operator= (IDiscovery &&) noexcept=delete
	Movement operator deleted. More...
Protected Member Functions inherited from eprosima::safedds::execution::ISpinnable
	~ISpinnable () noexcept=default
	Protected destructor ownership defined on creation. More...
	ISpinnable () noexcept=default
	Default creation. More...
	ISpinnable (const ISpinnable &) noexcept=default
	Copy allowed. More...
	ISpinnable (ISpinnable &&) noexcept=default
	Movement allowed. More...
ISpinnable &	operator= (const ISpinnable &) noexcept=default
	Copy operator allowed. More...
ISpinnable &	operator= (ISpinnable &&) noexcept=default
	Movement operator allowed. More...

Detailed Description

IDiscovery interface.

Constructor & Destructor Documentation

~IDiscovery()

eprosima::safedds::discovery::IDiscovery::~IDiscovery ( )

protecteddefaultnoexcept

Protected destructor ownership defined on creation.

IDiscovery() [1/3]

eprosima::safedds::discovery::IDiscovery::IDiscovery ( )

protecteddefaultnoexcept

Default creation.

IDiscovery() [2/3]

eprosima::safedds::discovery::IDiscovery::IDiscovery ( const IDiscovery &  )

protecteddeletenoexcept

Copy deleted.

IDiscovery() [3/3]

eprosima::safedds::discovery::IDiscovery::IDiscovery ( IDiscovery &&  )

protecteddeletenoexcept

Movement deleted.

Member Function Documentation

add_local_participant()

virtual ReturnCode eprosima::safedds::discovery::IDiscovery::add_local_participant ( const ParticipantInfo &  participant_info )

pure virtualnoexcept

Add local new participant.

Parameters

[in]

participant_info

ParticipantInfo of new participant.

Returns

ReturnCode.

add_local_publication()

virtual ReturnCode eprosima::safedds::discovery::IDiscovery::add_local_publication ( const PublicationInfo &  info )

pure virtualnoexcept

Add local new publication.

Parameters

[in]

info

PublicationInfo of new publication.

Returns

ReturnCode.

add_local_subscription()

virtual ReturnCode eprosima::safedds::discovery::IDiscovery::add_local_subscription ( const SubscriptionInfo &  info )

pure virtualnoexcept

Add local new subscription.

Parameters

[in]

info

SubscriptionInfo of new subscription.

Returns

ReturnCode.

decommission_local_participant()

virtual ReturnCode eprosima::safedds::discovery::IDiscovery::decommission_local_participant ( const protocol::GUIDPrefix &  participant_prefix )

pure virtualnoexcept

Decommission local participant.

Parameters

participant_prefix

GUID prefix of participant to decommission.

Returns

ReturnCode.

fill_local_participant_builtin_endpoints()

virtual void eprosima::safedds::discovery::IDiscovery::fill_local_participant_builtin_endpoints ( discovery::ParticipantInfo &  participant_info ) const

pure virtualnoexcept

Fill local participant builtin endpoints.

Parameters

[in,out]

participant_info

participant information.

operator=() [1/2]

IDiscovery& eprosima::safedds::discovery::IDiscovery::operator= ( const IDiscovery &  )

protecteddeletenoexcept

Copy operator deleted.

operator=() [2/2]

IDiscovery& eprosima::safedds::discovery::IDiscovery::operator= ( IDiscovery &&  )

protecteddeletenoexcept

Movement operator deleted.

---

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

• build/docs/user_manual/main/tmp/include/safedds/discovery/IDiscovery.hpp