iceoryx_doc
1.0.1
|
this class is the base for all ports. it is constructed from a member pointer and is only movable. only movable rational: a port has only one member, a pointer to its data. if a port is copied then both ports would work on the same data even though these are two independent copies. this would case a weird shared state, race conditions and so on More...
#include <base_port.hpp>
Public Types | |
using | MemberType_t = BasePortData |
Public Member Functions | |
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... | |
Protected Member Functions | |
const MemberType_t * | getMembers () const noexcept |
MemberType_t * | getMembers () noexcept |
this class is the base for all ports. it is constructed from a member pointer and is only movable. only movable rational: a port has only one member, a pointer to its data. if a port is copied then both ports would work on the same data even though these are two independent copies. this would case a weird shared state, race conditions and so on
before using a port it is, depending on the use case, important to verify that the port member pointers are set
|
noexcept |
Reads Type of actual CaPro Port (publisher/subscriber...)
|
noexcept |
returns node name for the active port
|
noexcept |
Gets name of the application's runtime for the active port.
|
noexcept |
Gets Id of the active port.
|
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
|
noexcept |
Checks whether port can be destroyed.