lintel 0.2.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
lintel::ProcessInfo Class Reference

#include <ProcessInfo.h>

Public Member Functions

 ProcessInfo (std::shared_ptr< Process > process, lintel::ProcessId id, bool isRunning, int exitCode, std::string groupName, std::string groupId, bool exitCodeValid=true, const std::optional< ProcessResourceData > &resourceData=std::nullopt)
 
const std::shared_ptr< Process > & getProcess () const
 
lintel::ProcessId getProcessId () const
 
constexpr bool isRunning () const
 
constexpr int getExitCode () const
 
constexpr bool isExitCodeValid () const
 
std::string getGroupName () const
 
std::string getGroupId () const
 
const std::optional< ProcessResourceData > & getResourceData () const
 

Detailed Description

Runtime information about a running process including its PID, status, group membership and (optional) resource usage.

Constructor & Destructor Documentation

◆ ProcessInfo()

lintel::ProcessInfo::ProcessInfo ( std::shared_ptr< Process >  process,
lintel::ProcessId  id,
bool  isRunning,
int  exitCode,
std::string  groupName,
std::string  groupId,
bool  exitCodeValid = true,
const std::optional< ProcessResourceData > &  resourceData = std::nullopt 
)

Constructor.

Parameters
processthe process definition
idOS process ID
isRunningwhether the process is currently running
exitCodeprocess exit code
groupNameprocess group name
groupIdprocess group UUID
exitCodeValidwhether the exit code is meaningful (i.e. the child was waited on)
resourceDataoptional resource snapshot

Member Function Documentation

◆ getExitCode()

constexpr int lintel::ProcessInfo::getExitCode ( ) const
inlineconstexpr
Returns
process exit code

◆ getGroupId()

std::string lintel::ProcessInfo::getGroupId ( ) const
Returns
group UUID

◆ getGroupName()

std::string lintel::ProcessInfo::getGroupName ( ) const
Returns
group name

◆ getProcess()

const std::shared_ptr< Process > & lintel::ProcessInfo::getProcess ( ) const
Returns
process definition

◆ getProcessId()

lintel::ProcessId lintel::ProcessInfo::getProcessId ( ) const
Returns
OS process ID

◆ getResourceData()

const std::optional< ProcessResourceData > & lintel::ProcessInfo::getResourceData ( ) const
Returns
process resource data, if readable on this platform

◆ isExitCodeValid()

constexpr bool lintel::ProcessInfo::isExitCodeValid ( ) const
inlineconstexpr
Returns
true if the reported exit code is meaningful

◆ isRunning()

constexpr bool lintel::ProcessInfo::isRunning ( ) const
inlineconstexpr
Returns
true if the process is running

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