iceoryx_doc  1.0.1
Public Member Functions | List of all members
iox::runtime::IpcRuntimeInterface Class Reference

Public Member Functions

 IpcRuntimeInterface (const RuntimeName_t &roudiName, const RuntimeName_t &runtimeName, const units::Duration roudiWaitingTimeout) noexcept
 Runtime Interface for the own IPC channel and the one to the RouDi daemon. More...
 
 IpcRuntimeInterface (const IpcRuntimeInterface &)=delete
 Not needed therefore deleted.
 
IpcRuntimeInterfaceoperator= (const IpcRuntimeInterface &)=delete
 
 IpcRuntimeInterface (IpcRuntimeInterface &&)=delete
 
IpcRuntimeInterfaceoperator= (IpcRuntimeInterface &&)=delete
 
bool sendKeepalive () noexcept
 sends the keep alive trigger to the RouDi daemon More...
 
bool sendRequestToRouDi (const IpcMessage &msg, IpcMessage &answer) noexcept
 send a request to the RouDi daemon More...
 
rp::BaseRelativePointer::offset_t getSegmentManagerAddressOffset () const noexcept
 get the adress offset of the segment manager More...
 
size_t getShmTopicSize () noexcept
 get the size of the management shared memory object More...
 
uint64_t getSegmentId () const noexcept
 get the segment id of the shared memory object More...
 

Constructor & Destructor Documentation

◆ IpcRuntimeInterface()

iox::runtime::IpcRuntimeInterface::IpcRuntimeInterface ( const RuntimeName_t &  roudiName,
const RuntimeName_t &  runtimeName,
const units::Duration  roudiWaitingTimeout 
)
noexcept

Runtime Interface for the own IPC channel and the one to the RouDi daemon.

Parameters
[in]roudiNamename of the RouDi IPC channel
[in]runtimeNamename of the application's runtime and its IPC channel
[in]roudiWaitingTimeouttimeout for searching the RouDi IPC channel

Member Function Documentation

◆ getSegmentId()

uint64_t iox::runtime::IpcRuntimeInterface::getSegmentId ( ) const
noexcept

get the segment id of the shared memory object

Returns
segment id

◆ getSegmentManagerAddressOffset()

rp::BaseRelativePointer::offset_t iox::runtime::IpcRuntimeInterface::getSegmentManagerAddressOffset ( ) const
noexcept

get the adress offset of the segment manager

Returns
address offset as rp::BaseRelativePointer::offset_t

◆ getShmTopicSize()

size_t iox::runtime::IpcRuntimeInterface::getShmTopicSize ( )
noexcept

get the size of the management shared memory object

Returns
size in bytes

◆ sendKeepalive()

bool iox::runtime::IpcRuntimeInterface::sendKeepalive ( )
noexcept

sends the keep alive trigger to the RouDi daemon

Returns
true if sending was successful, false if not

◆ sendRequestToRouDi()

bool iox::runtime::IpcRuntimeInterface::sendRequestToRouDi ( const IpcMessage msg,
IpcMessage answer 
)
noexcept

send a request to the RouDi daemon

Parameters
[in]msgrequest to RouDi
[out]answerresponse from RouDi
Returns
true if communication was successful, false if not

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