Encapsulate common UNIX OS functionality. More...

#include <LinuxHostOS.h>

Inheritance diagram for utl::LinuxHostOS:

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

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

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

void	setCanonicalTTY (int fd, bool canon)
	Enable/disable canonical mode for the given TTY. More...

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

int	run (const String &cmd)

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

virtual void	usleep (uint64_t usec) const
	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
	Get an environment variable. More...

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

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

Public Member Functions inherited from utl::HostOS
int	run (const String &cmd)
	A front-end for the virtual run(). More...

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

void	sleep (uint_t sec, uint_t usec) const
	Sleep for the given number of seconds and microseconds. 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

Encapsulate common UNIX OS functionality.

Author: Adam McKee

Definition at line 22 of file LinuxHostOS.h.

Member Function Documentation

◆ getPathSeparator()

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

virtual

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

Implements utl::HostOS.

◆ chdir()

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

virtual

Set the current working directory.

Parameters

path	new current working directory

Implements utl::HostOS.

◆ daemonInit()

virtual void utl::LinuxHostOS::daemonInit ( )

virtual

Become a system/daemon process.

Implements utl::HostOS.

◆ setCanonicalTTY()

void utl::LinuxHostOS::setCanonicalTTY	(	int	fd,
		bool	canon
	)

Enable/disable canonical mode for the given TTY.

Parameters

fd	file descriptor for TTY
canon	canonical mode enabled?

◆ run()

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

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

Implements utl::HostOS.

◆ sleep()

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

virtual

Sleep for the given number of seconds.

Implements utl::HostOS.

◆ usleep()

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

virtual

Sleep for the given number of microseconds.

Implements utl::HostOS.

◆ yield()

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

virtual

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

Reimplemented from utl::HostOS.

◆ getEnv()

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

virtual

Get an environment variable.

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

Implements utl::HostOS.

◆ setEnv()

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

virtual

Set an environment variable.

Returns: old value of environment variable

Parameters

envVarName	environment variable name
envVarVal	new value of environment variable

Implements utl::HostOS.

◆ remEnv()

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

virtual

Remove an environment variable.

Returns: old value of environment variable

Parameters

envVarName environment variable name

Implements utl::HostOS.

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

LinuxHostOS.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getPathSeparator()

◆ chdir()

◆ daemonInit()

◆ setCanonicalTTY()

◆ run()

◆ sleep()

◆ usleep()

◆ yield()

◆ getEnv()

◆ setEnv()

◆ remEnv()