Abstraction for common OS functionality. More...

#include <HostOS.h>

Inheritance diagram for utl::HostOS:

Public Member Functions
virtual char	getPathSeparator () const =0
	Get the pathname separator ('/' on UNIX). More...

virtual void	chdir (const Pathname &path)=0
	Set the current working directory. More...

virtual void	daemonInit ()=0
	Become a system/daemon process. More...

Process Management
virtual int	run (const Pathname &path, const TArray< String > &args)=0
	Run an executable with specified parameters. More...

int	run (const String &cmd)
	A front-end for the virtual run(). More...

Sleeping
void	msleep (uint64_t msec) const
	Sleep for the given number of milliseconds. More...

virtual void	sleep (uint_t sec) const =0
	Sleep for the given number of seconds. More...

void	sleep (uint_t sec, uint_t usec) const
	Sleep for the given number of seconds and microseconds. More...

virtual void	usleep (uint64_t usec) const =0
	Sleep for the given number of microseconds. More...

virtual void	yield () const
	Yield the processor to some other process that wants to run. More...

Environment
virtual String	getEnv (const String &envVarName) const =0
	Get an environment variable. More...

virtual String	setEnv (const String &envVarName, const String &envVarVal)=0
	Set an environment variable. More...

virtual String	remEnv (const String &envVarName)=0
	Remove an environment variable. More...

Public Member Functions inherited from utl::Object
void	clear ()
	Revert to initial state. More...

virtual int	compare (const Object &rhs) const
	Compare with another object. More...

virtual void	copy (const Object &rhs)
	Copy another instance. More...

virtual void	vclone (const Object &rhs)
	Make an exact copy of another instance. More...

virtual void	steal (Object &rhs)
	"Steal" the internal representation from another instance. More...

virtual void	dump (Stream &os, uint_t level=uint_t_max) const
	Dump a human-readable representation of self to the given output stream. More...

void	dumpWithClassName (Stream &os, uint_t indent=4, uint_t level=uint_t_max) const
	Front-end for dump() that prints the object's class name. More...

virtual const Object &	getKey () const
	Get the key for this object. More...

bool	hasKey () const
	Determine whether or not the object has a key. More...

virtual const Object &	getProxiedObject () const
	Get the proxied object (= self if none). More...

virtual Object &	getProxiedObject ()
	Get the proxied object (= self if none). More...

virtual size_t	hash (size_t size) const
	Get the hash code for the object. More...

bool	_isA (const RunTimeClass *runTimeClass) const
	Determine whether self's class is a descendent of the given class. More...

virtual String	toString () const
	Return a string representation of self. More...

	operator String () const
	Conversion to String. More...

size_t	allocatedSize () const
	Get the total allocated size of this object. More...

virtual size_t	innerAllocatedSize () const
	Get the "inner" allocated size. More...

virtual void	addOwnedIt (const class FwdIt *it) const
	Notify self that it owns the given iterator. More...

virtual void	removeOwnedIt (const class FwdIt *it) const
	Notify self that the given owned iterator has been destroyed. More...

bool	operator< (const Object &rhs) const
	Less-than operator. More...

bool	operator<= (const Object &rhs) const
	Less-than-or-equal-to operator. More...

bool	operator> (const Object &rhs) const
	Greater-than operator. More...

bool	operator>= (const Object &rhs) const
	Greater-than-or-equal-to operator. More...

bool	operator== (const Object &rhs) const
	Equal-to operator. More...

bool	operator!= (const Object &rhs) const
	Unequal-to operator. More...

void	serializeIn (Stream &is, uint_t mode=ser_default)
	Serialize from an input stream. More...

void	serializeOut (Stream &os, uint_t mode=ser_default) const
	Serialize to an output stream. More...

virtual void	serialize (Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize to or from a stream. More...

void	serializeOutBoxed (Stream &os, uint_t mode=ser_default) const
	Serialize a boxed object to an output stream. More...

Additional Inherited Members
Static Public Member Functions inherited from utl::Object
static Object *	serializeInNullable (Stream &is, uint_t mode=ser_default)
	Serialize a nullptr-able object from an input stream. More...

static void	serializeOutNullable (const Object *object, Stream &os, uint_t mode=ser_default)
	Serialize a nullptr-able object to an output stream. More...

static void	serializeNullable (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a nullptr-able object to or from a stream. More...

static Object *	serializeInBoxed (Stream &is, uint_t mode=ser_default)
	Serialize a boxed object from an input stream. More...

static void	serializeBoxed (Object *&object, Stream &stream, uint_t io, uint_t mode=ser_default)
	Serialize a boxed object to or from a stream. More...

Detailed Description

Abstraction for common OS functionality.

Author: Adam McKee

Definition at line 23 of file HostOS.h.

Member Function Documentation

◆ getPathSeparator()

virtual char utl::HostOS::getPathSeparator ( ) const

pure virtual

Get the pathname separator ('/' on UNIX).

Implemented in utl::LinuxHostOS, and utl::MinGWhostOS.

◆ chdir()

virtual void utl::HostOS::chdir ( const Pathname & path )

pure virtual

Set the current working directory.

Parameters

path	new current working directory

Implemented in utl::LinuxHostOS, and utl::MinGWhostOS.

◆ daemonInit()

virtual void utl::HostOS::daemonInit ( )

pure virtual

Become a system/daemon process.

Implemented in utl::LinuxHostOS, and utl::MinGWhostOS.

◆ run() [1/2]

virtual int utl::HostOS::run	(	const Pathname &	path,
		const TArray< String > &	args
	)

pure virtual

Run an executable with specified parameters.

Returns: exit code of given executable

Parameters

path	pathname of executable to run
args	parameters to run executable with

Implemented in utl::LinuxHostOS, and utl::MinGWhostOS.

◆ run() [2/2]

int utl::HostOS::run ( const String & cmd )

A front-end for the virtual run().

From the given string, it determines the executable path and the parameters, and invokes run(path,args). If you want to pass a parameter that contains whitespace, you must enclose it in double quotes, just as you would do with the shell.

Returns: exit code of command

Parameters

cmd	command to execute

◆ msleep()

void utl::HostOS::msleep ( uint64_t msec ) const

inline

Sleep for the given number of milliseconds.

Definition at line 66 of file HostOS.h.

◆ sleep() [1/2]

virtual void utl::HostOS::sleep ( uint_t sec ) const

pure virtual

Sleep for the given number of seconds.

Implemented in utl::LinuxHostOS, and utl::MinGWhostOS.

◆ sleep() [2/2]

void utl::HostOS::sleep	(	uint_t	sec,
		uint_t	usec
	)		const

inline

Sleep for the given number of seconds and microseconds.

Definition at line 76 of file HostOS.h.

◆ usleep()

virtual void utl::HostOS::usleep ( uint64_t usec ) const

pure virtual

Sleep for the given number of microseconds.

Implemented in utl::LinuxHostOS, and utl::MinGWhostOS.

◆ yield()

virtual void utl::HostOS::yield ( ) const

virtual

Yield the processor to some other process that wants to run.

Reimplemented in utl::LinuxHostOS.

◆ getEnv()

virtual String utl::HostOS::getEnv ( const String & envVarName ) const

pure virtual

Get an environment variable.

Returns: value of environment variable (empty string if undefined)

Implemented in utl::LinuxHostOS, and utl::MinGWhostOS.

◆ setEnv()

virtual String utl::HostOS::setEnv	(	const String &	envVarName,
		const String &	envVarVal
	)

pure virtual

Set an environment variable.

Returns: old value of environment variable

Parameters

envVarName	environment variable name
envVarVal	new value of environment variable

Implemented in utl::LinuxHostOS, and utl::MinGWhostOS.

◆ remEnv()

virtual String utl::HostOS::remEnv ( const String & envVarName )

pure virtual

Remove an environment variable.

Returns: old value of environment variable

Parameters

envVarName environment variable name

Implemented in utl::LinuxHostOS, and utl::MinGWhostOS.

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

HostOS.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getPathSeparator()

◆ chdir()

◆ daemonInit()

◆ run() [1/2]

◆ run() [2/2]

◆ msleep()

◆ sleep() [1/2]

◆ sleep() [2/2]

◆ usleep()

◆ yield()

◆ getEnv()

◆ setEnv()

◆ remEnv()