iox::runtime::PortConfigInfo Struct Reference

Stores information necessary to create the right type of port on RouDi side. Different types of ports are required if e.g. different types of shared memory are used (e.g. on GPU). More...

#include <iceoryx_posh/runtime/port_config_info.hpp>

Collaboration diagram for iox::runtime::PortConfigInfo:

Public Member Functions
	PortConfigInfo (const PortConfigInfo &) noexcept=default
	PortConfigInfo (PortConfigInfo &&) noexcept=default
PortConfigInfo &	operator= (const PortConfigInfo &) noexcept=default
PortConfigInfo &	operator= (PortConfigInfo &&) noexcept=default
	PortConfigInfo (uint32_t portType=DEFAULT_PORT_TYPE, uint32_t deviceId=DEFAULT_DEVICE_ID, uint32_t memoryType=DEFAULT_MEMORY_TYPE) noexcept
	creates a PortConfigInfo object
	PortConfigInfo (const cxx::Serialization &serialization) noexcept
	creates a PortConfigInfo object from its serialization
	operator cxx::Serialization () const noexcept
	creates a serilaization of the PortConfigInfo
bool	operator== (const PortConfigInfo &rhs) const noexcept
	comparison operator

Public Attributes
uint32_t	portType {DEFAULT_PORT_TYPE}
iox::mepoo::MemoryInfo	memoryInfo

Static Public Attributes
static constexpr uint32_t	DEFAULT_PORT_TYPE {0U}
static constexpr uint32_t	DEFAULT_DEVICE_ID {0U}
static constexpr uint32_t	DEFAULT_MEMORY_TYPE {0U}

Detailed Description

Stores information necessary to create the right type of port on RouDi side. Different types of ports are required if e.g. different types of shared memory are used (e.g. on GPU).

Constructor & Destructor Documentation

PortConfigInfo() [1/2]

iox::runtime::PortConfigInfo::PortConfigInfo ( uint32_t portType = DEFAULT_PORT_TYPE, uint32_t deviceId = DEFAULT_DEVICE_ID, uint32_t memoryType = DEFAULT_MEMORY_TYPE )

noexcept

creates a PortConfigInfo object

Parameters

[in]	portType	specifies the type of port to be created
[in]	deviceId	specifies the device the port operates on (CPU, GPUx etc.)
[in]	memoryType	encodes additional information about the memory used by the port

PortConfigInfo() [2/2]

iox::runtime::PortConfigInfo::PortConfigInfo ( const cxx::Serialization & serialization )

noexcept

creates a PortConfigInfo object from its serialization

Parameters

[in]

serialization

specifies the serialization from which the port is created

Member Function Documentation

operator==()

bool iox::runtime::PortConfigInfo::operator== ( const PortConfigInfo & rhs ) const

noexcept

comparison operator

Parameters

[in]

rhs

the right hand side of the comparison

---

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

• iceoryx_posh/runtime/port_config_info.hpp