iox::popo::ApplicationPort Class Reference

Inheritance diagram for iox::popo::ApplicationPort:

Collaboration diagram for iox::popo::ApplicationPort:

Public Types
using	MemberType_t = ApplicationPortData
Public Types inherited from iox::popo::BasePort
using	MemberType_t = BasePortData

Public Member Functions
	ApplicationPort (ApplicationPortData *const applicationPortDataPtr) noexcept
	ApplicationPort (const ApplicationPort &other)=delete
ApplicationPort &	operator= (const ApplicationPort &other)=delete
	ApplicationPort (ApplicationPort &&other)=default
ApplicationPort &	operator= (ApplicationPort &&other)=default
cxx::optional< capro::CaproMessage >	tryGetCaProMessage () noexcept
	get an optional CaPro message that was provided by the application More...
void	dispatchCaProMessage (const capro::CaproMessage &caProMessage) noexcept
	dispatch a CaPro message from the application side to the daemon More...
Public Member Functions inherited from iox::popo::BasePort
	BasePort (MemberType_t *const basePortDataPtr) noexcept
	BasePort (const BasePort &other)=delete
BasePort &	operator= (const BasePort &)=delete
	BasePort (BasePort &&) noexcept
BasePort &	operator= (BasePort &&) noexcept
	operator bool () const noexcept
	a port can be constructed from a nullptr, additionally it also can be moved and in these cases the member methods would work on a nullptr. to circumvent this problem More...
capro::ServiceDescription	getCaProServiceDescription () const noexcept
	Reads Type of actual CaPro Port (publisher/subscriber...) More...
RuntimeName_t	getRuntimeName () const noexcept
	Gets name of the application's runtime for the active port. More...
UniquePortId	getUniqueID () const noexcept
	Gets Id of the active port. More...
NodeName_t	getNodeName () const noexcept
	returns node name for the active port More...
void	destroy () noexcept
	Indicate that this port can be destroyed.
bool	toBeDestroyed () const noexcept
	Checks whether port can be destroyed. More...

Additional Inherited Members
Protected Member Functions inherited from iox::popo::BasePort
const MemberType_t *	getMembers () const noexcept
MemberType_t *	getMembers () noexcept

Member Function Documentation

dispatchCaProMessage()

void iox::popo::ApplicationPort::dispatchCaProMessage ( const capro::CaproMessage &  caProMessage )

noexcept

dispatch a CaPro message from the application side to the daemon

Parameters

[in]

caProMessage

tryGetCaProMessage()

cxx::optional<capro::CaproMessage> iox::popo::ApplicationPort::tryGetCaProMessage ( )

noexcept

get an optional CaPro message that was provided by the application

Returns

CaPro message, empty optional if no new messages

---

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

• iceoryx_posh/internal/popo/ports/application_port.hpp