StormByte::System::Process Class Reference

Process class for running external programs They will run immediately after creation. More...

#include <process.hxx>

Public Types
enum class	Status : unsigned short { RUNNING , SUSPENDED , TERMINATED }
	Process status. More...

Public Member Functions
	Process (const std::filesystem::path &prog, const std::vector< std::string > &args=std::vector< std::string >())
	Process (std::filesystem::path &&prog, std::vector< std::string > &&args=std::vector< std::string >())
	Process (const Process &proc)=delete
	Process (Process &&proc) noexcept
Process &	operator= (const Process &proc)=delete
Process &	operator= (Process &&proc) noexcept
virtual	~Process () noexcept
DWORD	Wait () noexcept
PROCESS_INFORMATION	Pid ()
void	Suspend ()
void	Resume ()
Process &	operator>> (Process &proc)
std::string &	operator>> (std::string &str) const
Process &	operator<< (const std::string &str)
void	operator<< (const System::_EoF &eof)

Protected Attributes
Status	m_status
	Process status.
STARTUPINFO	m_siStartInfo
	Startup information.
PROCESS_INFORMATION	m_piProcInfo
	Process information.
Pipe *	m_pstdout
	Standard output pipe.
Pipe *	m_pstdin
	Standard input pipe.
Pipe *	m_pstderr
	Standard error pipe.
std::filesystem::path	m_program
	Program path.
std::vector< std::string >	m_arguments
	Program arguments.
std::unique_ptr< std::thread >	m_forwarder
	Forwarder thread.

Friends
STORMBYTE_SYSTEM_PUBLIC std::ostream &	operator<< (std::ostream &ostream, const Process &proc)

Detailed Description

Process class for running external programs They will run immediately after creation.

Member Enumeration Documentation

Status

enum class StormByte::System::Process::Status : unsigned short

strong

Process status.

Process status

Enumerator
RUNNING	Process is running.
SUSPENDED	Process is suspended.
TERMINATED	Process is terminated.

Constructor & Destructor Documentation

Process() [1/4]

StormByte::System::Process::Process	(	const std::filesystem::path &	prog,
		const std::vector< std::string > &	args = std::vector< std::string >()
	)

Constructor

Parameters

prog	program
args	arguments

Process() [2/4]

StormByte::System::Process::Process	(	std::filesystem::path &&	prog,
		std::vector< std::string > &&	args = std::vector< std::string >()
	)

Constructor

Parameters

prog	program
args	arguments

Process() [3/4]

StormByte::System::Process::Process ( const Process &  proc )

delete

Copy constructor (deleted)

Parameters

proc

Process

Process() [4/4]

StormByte::System::Process::Process ( Process &&  proc )

noexcept

Move constructor

Parameters

proc

Process

~Process()

virtual StormByte::System::Process::~Process ( )

virtualnoexcept

Destructor

Member Function Documentation

operator<<() [1/2]

Process & StormByte::System::Process::operator<<

(

const std::string &

str

)

Writes to the process stdin

Parameters

str

string

Returns

Process reference

operator<<() [2/2]

void StormByte::System::Process::operator<<

(

const System::_EoF &

eof

)

Writes EOF to the process stdin

Parameters

eof

EoF

operator=() [1/2]

Process & StormByte::System::Process::operator= ( const Process &  proc )

delete

Assignment operator (deleted)

Parameters

proc

Process

operator=() [2/2]

Process & StormByte::System::Process::operator= ( Process &&  proc )

noexcept

Move assignment operator

Parameters

proc

Process

operator>>() [1/2]

Process & StormByte::System::Process::operator>>

(

Process &

proc

)

Binds current process stdout to a process stdin

Parameters

proc	target Process

Returns

Process reference

operator>>() [2/2]

std::string & StormByte::System::Process::operator>>

(

std::string &

str

)

const

Outputs the process stdout to a string

Parameters

str

string

Returns

string reference

Pid()

PROCESS_INFORMATION StormByte::System::Process::Pid

(

)

Gets the process id

Returns

process id

Resume()

void StormByte::System::Process::Resume

(

)

Resumes the process

Suspend()

void StormByte::System::Process::Suspend

(

)

Suspends the process

Wait()

DWORD StormByte::System::Process::Wait ( )

noexcept

Waits for the process to finish

Returns

exit code

Friends And Related Symbol Documentation

operator<<

STORMBYTE_SYSTEM_PUBLIC std::ostream & operator<< ( std::ostream &  ostream, const Process &  proc  )

friend

Outputs the process stdout to an ostream

Parameters

ostream	ostream
proc	Process

Returns

ostream reference

Outputs the process to an ostream

Parameters

ostream	ostream
proc	Process

Returns

ostream reference

---

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

• /home/runner/work/StormByte-System/StormByte-System/lib/public/StormByte/system/process.hxx