cosmos::SigInfo::ChildData Struct Reference

Additional data found in SigInfo with SIGCHILD. More...

#include <SigInfo.hxx>

Public Types
enum class	Event : int {   INVALID = -1 , EXITED = CLD_EXITED , KILLED = CLD_KILLED , DUMPED = CLD_DUMPED ,   TRAPPED = CLD_TRAPPED , STOPPED = CLD_STOPPED , CONTINUED = CLD_CONTINUED }
	Types of SIGCHLD events that can occur. More...

Public Member Functions
bool	exited () const
	Returns whether the child exited.
bool	killed () const
	Returns whether the child was killed by a signal.
bool	dumped () const
	Returns whether the child dumped core due to a signal.
bool	trapped () const
	Returns true if the child entered a tracing trap.
bool	continued () const
	Returns whether the child continued due to a signal.
bool	stopped () const
	Returns whether the child stopped.
bool	exitedSuccessfully () const
	Returns whether the child exited and had an exit status of 0.
bool	signaled () const
	Returns whether the child received a signal.
bool	valid () const
	Returns whether the structure contains valid information.
void	reset ()

Public Attributes
Event	event
	The kind of child process event that occurred.
ProcessCtx	child
	the PID and its real user ID the signal is about.
std::optional< ExitStatus >	status
	Contains the process's exit status, if applicable.
std::optional< Signal >	signal
	Contains the signal number that caused the child process to change state.
std::optional< ClockTicks >	user_time
	The CPU time the child spent in user space.
std::optional< ClockTicks >	system_time
	The CPU time the child spent in kernel space.

Detailed Description

Additional data found in SigInfo with SIGCHILD.

Definition at line 321 of file SigInfo.hxx.

Member Enumeration Documentation

Event

enum class cosmos::SigInfo::ChildData::Event : int

strong

Types of SIGCHLD events that can occur.

Enumerator
EXITED	Child has exited.
KILLED	Child was killed.
DUMPED	Child terminated abnormally due to a signal, dumping core.
TRAPPED	Traced child has trapped.
STOPPED	Child has stopped due to a signal.
CONTINUED	Stopped child has continued.

Definition at line 325 of file SigInfo.hxx.

                                 : int {
                        INVALID   = -1,
                        EXITED    = CLD_EXITED,   
                        KILLED    = CLD_KILLED,   
                        DUMPED    = CLD_DUMPED,   
                        TRAPPED   = CLD_TRAPPED,  
                        STOPPED   = CLD_STOPPED,  
                        CONTINUED = CLD_CONTINUED 
                };

Member Function Documentation

continued()

bool cosmos::SigInfo::ChildData::continued ( ) const

inline

Returns whether the child continued due to a signal.

Definition at line 350 of file SigInfo.hxx.

{ return event == Event::CONTINUED; }

dumped()

bool cosmos::SigInfo::ChildData::dumped ( ) const

inline

Returns whether the child dumped core due to a signal.

Definition at line 344 of file SigInfo.hxx.

{ return event == Event::DUMPED; }

exited()

bool cosmos::SigInfo::ChildData::exited ( ) const

inline

Returns whether the child exited.

Definition at line 338 of file SigInfo.hxx.

{ return event == Event::EXITED; }

exitedSuccessfully()

bool cosmos::SigInfo::ChildData::exitedSuccessfully ( ) const

inline

Returns whether the child exited and had an exit status of 0.

Definition at line 356 of file SigInfo.hxx.

                                                {
                        return exited() && *status == ExitStatus::SUCCESS;
                }

killed()

bool cosmos::SigInfo::ChildData::killed ( ) const

inline

Returns whether the child was killed by a signal.

Definition at line 341 of file SigInfo.hxx.

{ return event == Event::KILLED; }

reset()

void cosmos::SigInfo::ChildData::reset ( )

inline

Definition at line 373 of file SigInfo.hxx.

                             {
                        event = Event::INVALID;
                        child.pid = ProcessID::INVALID;
                        status = std::nullopt;
                        signal = std::nullopt;
                }

signaled()

bool cosmos::SigInfo::ChildData::signaled ( ) const

inline

Returns whether the child received a signal.

Definition at line 361 of file SigInfo.hxx.

                                      {
                        return event == Event::KILLED ||
                                event == Event::DUMPED ||
                                event == Event::STOPPED ||
                                event == Event::CONTINUED;
                }

stopped()

bool cosmos::SigInfo::ChildData::stopped ( ) const

inline

Returns whether the child stopped.

Definition at line 353 of file SigInfo.hxx.

{ return event == Event::STOPPED; }

trapped()

bool cosmos::SigInfo::ChildData::trapped ( ) const

inline

Returns true if the child entered a tracing trap.

Definition at line 347 of file SigInfo.hxx.

{ return event == Event::TRAPPED; }

valid()

bool cosmos::SigInfo::ChildData::valid ( ) const

inline

Returns whether the structure contains valid information.

Definition at line 369 of file SigInfo.hxx.

                                   {
                        return event != Event::INVALID;
                }

Member Data Documentation

child

ProcessCtx cosmos::SigInfo::ChildData::child

the PID and its real user ID the signal is about.

Definition at line 385 of file SigInfo.hxx.

event

Event cosmos::SigInfo::ChildData::event

The kind of child process event that occurred.

Definition at line 383 of file SigInfo.hxx.

signal

std::optional<Signal> cosmos::SigInfo::ChildData::signal

Contains the signal number that caused the child process to change state.

This signal number is only available for events other than Event::EXITED. Otherwise status is available instead.

Definition at line 399 of file SigInfo.hxx.

status

std::optional<ExitStatus> cosmos::SigInfo::ChildData::status

Contains the process's exit status, if applicable.

An exit status is only available for Event::EXITED. In the other cases a signal is available instead.

Definition at line 392 of file SigInfo.hxx.

system_time

std::optional<ClockTicks> cosmos::SigInfo::ChildData::system_time

The CPU time the child spent in kernel space.

This does not include the time of waited-for children of the child.

This data is not available from the cosmos::proc::wait() family of functions.

Definition at line 418 of file SigInfo.hxx.

user_time

std::optional<ClockTicks> cosmos::SigInfo::ChildData::user_time

The CPU time the child spent in user space.

This does not include the time of waited-for children of the child.

This data is not available from the cosmos::proc::wait() family of functions.

Definition at line 409 of file SigInfo.hxx.

---

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

• include/proc/SigInfo.hxx