Skip to content

iox::runtime::PortConfigInfo🔗

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). #include <iceoryx_posh/runtime/port_config_info.hpp>

Public Functions🔗

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

Public Attributes🔗

Name
constexpr uint32_t DEFAULT_PORT_TYPE
constexpr uint32_t DEFAULT_DEVICE_ID
constexpr uint32_t DEFAULT_MEMORY_TYPE
uint32_t portType
iox::mepoo::MemoryInfo memoryInfo

Public Functions Documentation🔗

function PortConfigInfo🔗

PortConfigInfo(
    const PortConfigInfo & 
) =default

function PortConfigInfo🔗

PortConfigInfo(
    PortConfigInfo && 
) =default

function operator=🔗

PortConfigInfo & operator=(
    const PortConfigInfo & 
) =default

function operator=🔗

PortConfigInfo & operator=(
    PortConfigInfo && 
) =default

function PortConfigInfo🔗

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

creates a PortConfigInfo object

Parameters:

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

function PortConfigInfo🔗

PortConfigInfo(
    const cxx::Serialization & serialization
)

creates a PortConfigInfo object from its serialization

Parameters:

  • serialization specifies the serialization from which the port is created

function operator cxx::Serialization🔗

operator cxx::Serialization() const

creates a serilaization of the PortConfigInfo

function operator==🔗

bool operator==(
    const PortConfigInfo & rhs
) const

comparison operator

Parameters:

  • rhs the right hand side of the comparison

Public Attributes Documentation🔗

variable DEFAULT_PORT_TYPE🔗

static constexpr uint32_t DEFAULT_PORT_TYPE {0U};

variable DEFAULT_DEVICE_ID🔗

static constexpr uint32_t DEFAULT_DEVICE_ID {0U};

variable DEFAULT_MEMORY_TYPE🔗

static constexpr uint32_t DEFAULT_MEMORY_TYPE {0U};

variable portType🔗

uint32_t portType {DEFAULT_PORT_TYPE};

variable memoryInfo🔗

iox::mepoo::MemoryInfo memoryInfo;

Updated on 18 December 2023 at 13:11:43 CET