iceoryx_doc  1.0.1
Public Member Functions | List of all members
iox::roudi::Process Class Reference

Public Member Functions

 Process (const RuntimeName_t &name, const uint32_t pid, const posix::PosixUser &user, const bool isMonitored, const uint64_t sessionId) noexcept
 This class represents an application which has registered at RouDi and manages the communication to the application. More...
 
 Process (const Process &other)=delete
 
Processoperator= (const Process &other)=delete
 
 Process (Process &&other)=delete
 
Processoperator= (Process &&other)=delete
 
uint32_t getPid () const noexcept
 
const RuntimeName_t getName () const noexcept
 
void sendViaIpcChannel (const runtime::IpcMessage &data) noexcept
 
uint64_t getSessionId () noexcept
 The session ID which is used to check outdated IPC channel transmissions for this process. More...
 
void setTimestamp (const mepoo::TimePointNs_t timestamp) noexcept
 
mepoo::TimePointNs_t getTimestamp () noexcept
 
posix::PosixUser getUser () const noexcept
 
bool isMonitored () const noexcept
 

Constructor & Destructor Documentation

◆ Process() [1/2]

iox::roudi::Process::Process ( const RuntimeName_t &  name,
const uint32_t  pid,
const posix::PosixUser &  user,
const bool  isMonitored,
const uint64_t  sessionId 
)
noexcept

This class represents an application which has registered at RouDi and manages the communication to the application.

Parameters
[in]nameof the process; this is equal to the IPC channel name, which is used for communication
[in]pidis the host system process id
[in]useris user used in the operating system for this process
[in]isMonitoredindicates if the process should be monitored for being alive
[in]sessionIdis an ID generated by RouDi to prevent sending outdated IPC channel transmission

◆ Process() [2/2]

iox::roudi::Process::Process ( Process &&  other)
delete
Note
the move cTor and assignment operator are already implicitly deleted because of the atomic

Member Function Documentation

◆ getSessionId()

uint64_t iox::roudi::Process::getSessionId ( )
noexcept

The session ID which is used to check outdated IPC channel transmissions for this process.

Returns
the session ID for this process

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