Functions
bool	stk::path_exists (const std::string &path)
	Function path_exists returns true if the path exists.
bool	stk::path_access (const std::string &path, int mode)
	Function path_access returns true if the process has permission to access path with the specified mode.
bool	stk::path_read_access (const std::string &path)
	Function path_read_access returns true if the process has read access to the path.
bool	stk::path_write_access (const std::string &path)
	Function path_write_access returns true if the process has write access to the path.
bool	stk::read_lock (int fd)
	Function read_lock returns true if the process was able to place a shared lock on the specified file descriptor.
bool	stk::write_lock (int fd)
	Function write_lock returns true if the process was able to place an exclusive lock on the specified file descriptor.
bool	stk::append_lock (int fd)
	Function append_lock returns true if the process was able to place an exclusive lock on the end of the specified file descriptor. Existing records may still be accessed.
bool	stk::release_lock (int fd)
	Function release_lock returns true if the process was able to release a lock previously palced on the specified file descriptor.
std::string	stk::hostname ()
	Function hostname returns the hostname of the host running the application.
std::string	stk::domainname ()
	Function domainname returns the domainname of the domain running the application.
std::string	stk::username ()
	Function username returns the username of the user running the application.
std::string	stk::hardware ()
	Function hardware returns the hardware type of the host running the application.
std::string	stk::osname ()
	Function osname returns the operating system nameof the host running the application.
std::string	stk::osversion ()
	Function osversion returns the hardware type of the host running the application.
int	stk::pid ()
	Function pid returns the process id of the process running the application.
int	stk::pgrp ()
	Function pgrp returns the process group id of the process running the application.

Function Documentation

bool stk::path_exists ( const std::string & path )

Function path_exists returns true if the path exists.

Parameters:

path	a String const reference to the path to have existence tested.

Returns:: a bool value of true if the path exists.

Definition at line 103 of file FileSystem.cpp.

bool stk::path_access	(	const std::string &	path,
		int	mode
	)

Function path_access returns true if the process has permission to access path with the specified mode.

Parameters:

path	a String const reference to the path to check for mode access.
mode	an int value of the mode to test.

Returns:: a bool value of true of the process has permission to access the path with mode access.

Definition at line 93 of file FileSystem.cpp.

bool stk::path_read_access ( const std::string & path )

Function path_read_access returns true if the process has read access to the path.

Parameters:

path	a String const reference to the path to check for read access.

Returns:: a bool value of true of the process has permission to access the path with read access.

Definition at line 111 of file FileSystem.cpp.

bool stk::path_write_access ( const std::string & path )

Function path_write_access returns true if the process has write access to the path.

Parameters:

path	a String const reference to the path to check for write access.

Returns:: a bool value of true of the process has permission to access the path with write access.

Definition at line 119 of file FileSystem.cpp.

bool stk::read_lock ( int fd )

Function read_lock returns true if the process was able to place a shared lock on the specified file descriptor.

Parameters:

fd	an int value of the file description to attempt to lock.

Returns:: a bool value of true of the lock succeeded.

Definition at line 170 of file FileSystem.cpp.

bool stk::write_lock ( int fd )

Function write_lock returns true if the process was able to place an exclusive lock on the specified file descriptor.

Parameters:

fd	an int value of the file description to attempt to lock.

Returns:: a bool value of true of the lock succeeded.

Definition at line 146 of file FileSystem.cpp.

bool stk::append_lock ( int fd )

Function append_lock returns true if the process was able to place an exclusive lock on the end of the specified file descriptor. Existing records may still be accessed.

Parameters:

fd	an int value of the file description to attempt to lock.

Returns:: a bool value of true of the lock succeeded.

Definition at line 178 of file FileSystem.cpp.

bool stk::release_lock ( int fd )

Function release_lock returns true if the process was able to release a lock previously palced on the specified file descriptor.

Parameters:

fd	an int value of the file description to have the lock released.

Returns:: a bool value of true of the lock release succeeded.

Definition at line 158 of file FileSystem.cpp.

std::string stk::hostname ( )

Function hostname returns the hostname of the host running the application.

Returns:: a String value of the host name obtained from the operating system.

Definition at line 96 of file OperatingSystem.cpp.

std::string stk::domainname ( )

Function domainname returns the domainname of the domain running the application.

Returns:: a String value of the domain name obtained from the operating system.

Definition at line 105 of file OperatingSystem.cpp.

std::string stk::username ( )

Function username returns the username of the user running the application.

Returns:: a String value of the username obtained from the operating system.

Definition at line 135 of file OperatingSystem.cpp.

std::string stk::hardware ( )

Function hardware returns the hardware type of the host running the application.

Returns:: a String value of the machine field of the uname system call or equivalent obtained from the operating system.

Definition at line 148 of file OperatingSystem.cpp.

std::string stk::osname ( )

Function osname returns the operating system nameof the host running the application.

Returns:: a String value of the sysname field of the uname system call or equivalent obtained from the operating system.

Definition at line 164 of file OperatingSystem.cpp.

std::string stk::osversion ( )

Function osversion returns the hardware type of the host running the application.

Returns:: a String value of the release field of the uname system call or equivalent obtained from the operating system.

Definition at line 180 of file OperatingSystem.cpp.

int stk::pid ( )

Function pid returns the process id of the process running the application.

Returns:: a int value of the process id obtained from the operating system.

Definition at line 196 of file OperatingSystem.cpp.

int stk::pgrp ( )

Function pgrp returns the process group id of the process running the application.

Returns:: a int value of the process group id obtained from the operating system.

Definition at line 203 of file OperatingSystem.cpp.

Functions

Function Documentation