iceoryx_doc  1.0.1
Public Member Functions | List of all members
iox::popo::InterfacePort Class Reference
Inheritance diagram for iox::popo::InterfacePort:
Inheritance graph
[legend]
Collaboration diagram for iox::popo::InterfacePort:
Collaboration graph
[legend]

Public Member Functions

 InterfacePort (InterfacePortData *const interfacePortDataPtr) noexcept
 
 InterfacePort (const InterfacePort &other)=delete
 
InterfacePortoperator= (const InterfacePort &other)=delete
 
 InterfacePort (InterfacePort &&other)=default
 
InterfacePortoperator= (InterfacePort &&other)=default
 
cxx::optional< capro::CaproMessagetryGetCaProMessage () noexcept
 get an optional CaPro message for the interface port to process More...
 
void dispatchCaProMessage (const capro::CaproMessage &caProMessage) noexcept
 dispatch a CaPro message to this interface port More...
 
- Public Member Functions inherited from iox::popo::BasePort
 BasePort (MemberType_t *const basePortDataPtr) noexcept
 
 BasePort (const BasePort &other)=delete
 
BasePortoperator= (const BasePort &)=delete
 
 BasePort (BasePort &&) noexcept
 
BasePortoperator= (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

- Public Types inherited from iox::popo::BasePort
using MemberType_t = BasePortData
 
- Protected Member Functions inherited from iox::popo::BasePort
const MemberType_tgetMembers () const noexcept
 
MemberType_tgetMembers () noexcept
 

Member Function Documentation

◆ dispatchCaProMessage()

void iox::popo::InterfacePort::dispatchCaProMessage ( const capro::CaproMessage caProMessage)
noexcept

dispatch a CaPro message to this interface port

Parameters
[in]caProMessage

◆ tryGetCaProMessage()

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

get an optional CaPro message for the interface port to process

Returns
CaPro message, empty optional if no new messages

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