xvr2 Namespace Reference


Detailed Description

This is the main namespace, al core stuff happens here.


Classes

class  BackgroundFunction
 Interface class for functions which are to be ran in the background as a separate thread subprocess. More...
class  BasicString
 Abstract string base class. More...
class  BasicStringBuffer
class  Buffer
 Represents a data block and as such it holds a data store and a means to account the amount of stored data. More...
class  BufferedTextInputStream
class  Byte
 This class represents a Byte, bit by bit and provides a means for accesing each bit individually. More...
class  Calendar
 Use this class to represent calendar objects. More...
class  Chronograph
 This class deals with time based backward counters. More...
class  Chronometer
 This class deals with time counters. More...
class  ConditionVar
 Condition variables is another type of synchronization device unlike the Mutex how locks and unlocks a thread, this devide does somethings a bit different, this one waits for a condition to be reached, if the condition in fact has been accomplished it will lock and unlock a thread or a set of threads that might be waiting for a conditiond to be reached on that specific ConditionVar object. More...
class  Console
 This class represents the console object, use to retreive and send data to the current Unix console. More...
class  Exception
 This is the parent class of all the exceptions. More...
class  BufferTooSmall
 To be thrown when you are trying to write data in a buffer whose storage size is too small. More...
class  ArrayIndexOutOfLimits
 Throw this exception when an operation over an array exceeds its inbound or outbound limits. More...
class  ElementNotFound
 Use this exception when a search for an element returned no results or the results given doens't match what you were looking for. More...
class  GroupException
 Generic exception for the group class. More...
class  MemoryException
 Generic memory exception. More...
class  MutexException
 This is the generic exception thrown for mutexes. More...
class  NoMoreTokens
 Use or trap this exception when you need to check if a Tokenizer has no more tokens to find in the current string. More...
class  NullPointer
 Throw this exception when doing something that is not appropiate with a null pointer. More...
class  NumberException
 Throw this exception when expecting a number in an operation and and receiving something different. More...
class  ParseException
 Generic parsing exception. More...
class  SecurityException
 This is a generic exception for security-related events. More...
class  ThreadException
 ThreadException Generic Exception. More...
class  UserException
 Generic exception of the user class. More...
class  UndefinedClassException
class  GroupNotFound
 This exception is thrown whenever you are trying to browse the group database for a specific entry and that entry is not available or non-existent. More...
class  AllocationFailed
 This exceptions might be thrown if a call to malloc or any other memory allocation routine has just failed, it may be posible that you are running out of memory or that this process is trying to allocate the maximum allowable memory size in the current system, sorry. More...
class  ReallocFailed
 I was unable to decrease/enlarge your memory buffer. More...
class  DeadLock
 This exception is triggered when a deadlock is detected. More...
class  UnableToLockMutex
 This exception is used when a mutex failed to lock the current thread. More...
class  UnableToUnlockMutex
 This exception is used when a mutex failed to unlock the current thread. More...
class  DateParseException
 Unable to parse and obtain a Date from the current object. More...
class  TimeParseException
 Unable to parse and obtain a Time instance from the current object. More...
class  BitParseException
 This exception is thrown whenever you try to parse bit from an undefined format string or a too hard to transform datatype. More...
class  ByteParseException
 Unable to parse a byte from here, probably the data is smaller than a byte? More...
class  UserIDDoesNotMatch
 This is a generic exception for security-related events. More...
class  SemaphoreException
 Generic semaphore exception. More...
class  ThreadNotRunning
 If you try to execute an operation that can only be placed over a running Thred and you're current thread is not running yet this is the exception that is going to be thrown. More...
class  MaximumNumberOfRunningThreadsReached
 Tbis exception is thrown if while attempting to start a new thread the maximum number of threads supported by the OS has been reached. More...
class  ConditionVarWaitTimedOut
 The condition variable was signaled before wait interval has been reached, as a consecuence the controlled Mutex will be re-acquired. More...
class  InvalidThread
 The user provided thread object is not being managed by the ThreadManager so its is invalid. More...
class  SemaphoreInitValueException
 The initialization value for this semaphore is too big, unable to create semaphore, sorry. More...
class  SemaphoreUnableToDestroy
 I'm unable to destroy this semaphore right now, maybe one or more threads are waiting for it. More...
class  SemaphoreUnableToDecrease
 Unable to decrease this semaphore's value, it is already very low. More...
class  SemaphoreUnableToIncrease
 I'm unable to increase the value of this semaphore right now is bigger than the maximum defined by this thread implementation, sorry. More...
class  UserNotFound
 This exception is thrown whenever you are trying to browse the user database for a specific entry and that entry is not available or non-existent. More...
class  Date
 This class implements the basic date/time handling facilities. More...
class  DebugConsole
class  Deque
class  DetachedThread
class  DSO
 This is the plugin class, it adds an interface for loading dynamic shared objects to your program. More...
class  DSObjectFactory
class  FileExists
 Exception thrown when the file to be used alreadyeady exists. More...
class  FeatureNotAvailableOnPipesOrSocket
 This exception is thrown when u are attempting to execute an operation that is only valid to common files and for PIPEs or Sockets. More...
class  ThisIsADirectory
 This exception will be thrown only if you are attempting to open a file but the given filename corresponds to a directory. More...
class  PermissionDenied
 This exception will be thrown only if the current process does not own the rights to do a specific operation on this file. More...
class  FilenameTooLong
 This exception will be thrown only if you are attempting to open a very large filename. More...
class  FileOrDirectoryNotFound
 This exception will be thrown only if you are opening a file for reading and the currently opened file does not exist. More...
class  ThisIsNotADirectory
 This exception will be thrown only if you are attempting to open a directory and the given filename is not a directory. More...
class  FileNotOpened
 This exception will be thrown only if you attempt to execute an operation on a non-opened file. More...
class  UnableToWriteOnReadOnlyFile
 This exception will be thrown only if you are trying to write on a read only opened file. More...
class  UnableToWriteOnRunningExecutableFile
 This exception will be thrown only if you are trying to write on an executable file of process which is already running. More...
class  FilenameExceedsAddressSpace
 This exception will be thrown only if you are trying to reach file which is outside of the address provided by its parent directory. More...
class  TooManySymlinks
 This exception will be thrown only if the file you are trying to read is the last symlink in a very large chain. More...
class  NotEnoughStorageSpace
 This exception will be thrown only if there is not enough room to to open this file. More...
class  MaximumNumberOfOpenFilesForThisProcess
 This exception will be thrown only if the maximum number of opened files. More...
class  MaximumNumberOfOpenFilesForThisSystem
 This exception will be thrown only if this system has reached the maximum number of opened files that the kernel can handle. More...
class  FileTooBig
 This exception is thrown whenever you attempt to write pass the maximum offset allowed or while writing a file will make it grow pass the implementation defined size for the current OS. More...
class  WriteWillBlock
 The file was opened with NON-BLOCKING feature but if u write the process will block every I/O. More...
class  FileNotFound
 Unable to find the requested file. More...
class  InvalidFileDescriptor
 Exception thrown when the given value is not actually a file descriptor. More...
class  FinalizerCallback
class  Function
 Interface class for implementing object functions. More...
class  Group
 This class deals with group management and also provides means to search the system's user group database. More...
class  InvalidParameter
 This exception is thrown whenever you call a system call with an invalid parameter. More...
class  JoinableThread
class  Log
 This class manages basic log file handling. More...
class  Map
class  Memory
 This class implement basic memory management tasks. More...
class  Mutex
 This classes handle MUTEX (MUTual EXclusion) sinchronization devices
This classes are designed to work with SDL's Thread encapsulation, GNU Pth or POSIX Threads. More...
class  MutexAlreadyLocked
class  Object
 This one is the most primitive of all the classes, the first ancestor. More...
class  Pipeline
class  PipelineFilter
class  Plugin
 This is the plugin class, it adds an interface for loading dynamic shared objects to your program. More...
class  Queue
class  RawInputStream
class  RawInputStreamTimeoutException
class  RawOutputStream
class  RawStreamInterface
class  Semaphore
 This class implements mutual exclusion semaphore objects. More...
class  SharedVar
 This class is define template to implemented Shared varibles. More...
class  StandardError
 This class represents the Standard Error output stream. More...
class  StandardInput
 This class represents the standard input stream as a TextInput object. More...
class  StandardOutput
 This class represents the Standard Output output stream. More...
class  StdioInputFile
class  StdioInterface
class  StdioInterfaceException
class  StdioOutputFile
class  StreamException
class  StreamIsNotFlushable
class  StreamIsNotSeekable
class  StreamInterface
 File interface class. More...
class  ReadableStream
 Implements readable/input streams. More...
class  WriteableStream
 Implements writeable/output files. More...
class  String
 The String class!!! This a string treatment class, it has a lot of methods and the main idea is eliminate de use of the common tricks we use everyday while we work with strings. More...
class  StringBuffer
class  Syslog
 This class handles the Syslog daemon. More...
class  System
 This class is an interface for all System classes. More...
class  SystemException
 General platform dependent exception which interfaces with host OS C library error reporting facilities. More...
class  IOException
 This is a generic exception for I/O events. More...
class  DSOException
 Use this exception whenever you want to throw a generic exception over a dso (dynamic shared object) event. More...
class  FileException
 You will only be seeing this exception if a generic (undetermined) exception has occurred on a file-based class. More...
class  NotEnoughKernelMemory
 This exception will be thrown only if there is not enough memory for kernel use. More...
class  BrokenPipe
 This exception is thrown whenever the other end of communication has died or in the case of a socket when the remote host has closed connection without warning. More...
class  ProcOutOfFileDescriptors
 This exception is thrown when the process is going out of files. More...
class  SysOutOfFileDescriptors
 This exception is thrown when the system is going out of files. More...
class  DeviceOrFIFONotFound
 This exception will be thrown only if while trying to open a FIFO filename the process owning the PIPE is not running or while trying to access a special device filename and the associated hardware is non-existent. More...
class  DeviceNotFound
 This exception will be thrown only if while trying to open a special device file the associated hardware is not properly connected to the system. More...
class  InterruptedSystemCall
 This exception is thrown whenever a system call is interrupted by another. More...
class  SocketUnableToWrite
 This exception is thrown if it is not possible to write data to the other end of communications. More...
class  SocketUnableToRead
 This exception is thrown if it is not possible to read data from the other end of communications. More...
class  CantLoadDSO
 This exception is thown whenever you're trying to load a DSOException and some error ocurred. More...
class  CantUnloadDSO
 If a DSOException cannot be unloaded, this exception is thrown. More...
class  DSOSymbolException
 This is a common error appearing whenever you cant load a symbol from a DSOException. More...
class  TextInput
 This class is like a PIPE, it holds a method for inputing text from an object, this object \ can be a file a stream or any other thing, please note that this class is just an interface, for every text input subsystem that may exist in a future. More...
class  TextOutput
 This class is like a PIPE, it holds a method for outputing text to a receiving object, this object \ can be a file a stream or any other thing, please note that this class is just an interface, for every text ouput subsystem that may exist in a future. More...
class  Thread
class  ThreadFinalizator
 Interface class for handling Thread finalization stuff. More...
struct  Threading
 This class is an interface for all Threading classes. More...
class  ThreadManager
 This class brings basic thread creation management functions, and permits running tasks concurrently. More...
class  Time
 This class represents the time object. More...
class  Timestamp
 This class implements the Timestamp functionality, it will store the timestamp the first time it is instanciated. More...
class  Tokenizer
 This utilitary class is used whenever you need to split a string into tokens iteratively. More...
class  ExceptionTracer
class  Unix
 This class implements the most common Unix system calls. More...
class  User
 This class deals with user management and numeric id setup on on running processes. More...
class  Vector
 Same as std::vector, but including some exclusive features from X-VR2. More...

Namespaces

namespace  Text
namespace  SQL
namespace  Net
namespace  Platform

Functions

template<class __ttype_x>
void xvr2_delete (__ttype_x &ptr)
 Use this function in place of the delete operator for pointers, after it has been successfully called the argument will point to the NULL (0x0) address.
template<class __ttype_y>
void xvr2_delete_array (__ttype_y &array)
 Use this function in place of the delete[] operator for arrays, after it has been successfully called the argument will point to the NULL (0x0) address.
const Int32 String2Int32 (const String &s, int base=10)
 Converts the given string s into an Int32 value.
const Int64 String2Int64 (const String &s, int base=10)
 Converts the given string s into an Int64 value.
const UInt32 String2UInt32 (const String &s, int base=10)
 Converts the given string s into an UInt32 value.
const UInt64 String2UInt64 (const String &s, int base=10)
 Converts the given string s into an UInt64 value.
const float String2float (const String &s)
 Converts the given string s into a float value.
const double String2double (const String &s)
 Converts the given string s into a double value.
const long double String2longdouble (const String &s)
 Converts the given string s into a long double value.

Variables

DebugConsole debugConsole
 Standard X-VR2 debug console.
const char * strGenericException
const char * excepAOB
const char * excepNullPtr
const char * excepNumeric
const char * excepNoElem
const char * excepNoTokens
const char * excepGenMutex
const char * excepMutexNoLock
const char * excepMutexNoUnlock
const char * excepGenNet
const char * excepNetTimeout
const char * excepNetRefused
const char * excepNetUnreach
const char * excepGenIO
const char * excepBrokenPipe
const char * excepSockUsed
const char * excepSockListening
const char * excepNoFptrs
const char * excepSysNoFptrs
const char * excepSendFailed
const char * excepRecvFailed
const char * excepGenDSO
const char * excepNoLoadDSO
const char * excepNoUnloadDSO
const char * excepNoLoadSymbol
const char * excepDeadLock
const char * excepGenThread
const char * excepThreadNotRunning
const char * excepFileExists
const char * excepThisIsADirectory
const char * excepPermissionDenied
const char * excepFilenameTooLong
const char * excepFileOrDirectoryNotFound
const char * excepThisIsNotADirectory
const char * excepDeviceOrFIFONotFound
const char * excepDeviceNotFound
const char * excepUnableToWriteOnReadOnlyFile
const char * excepUnableToWriteOnRunningExecutableFile
const char * excepFilenameExceedsAddressSpace
const char * excepTooManySymlinks
const char * excepNotEnoughStorageSpace
const char * excepNotEnoughKernelMemory
const char * excepMaximumNumberOfOpenFilesForThisProcess
const char * excepMaximumNumberOfOpenFilesForThisSystem
const char * excepFile
const char * excepFileNotOpened
const char * excepUserIDDoesNotMatch
const char * excepSecurity
const char * excepFileTooBig
const char * msgNothingLoaded
const char * msgThreadOverride
const char * msgDetachingThread
const char * excepInvalidParameter
const char * excepFeatureNotAvailableOnPipesOrSocket
const char * constDEVNULL
const char * excepWriteWillBlock
const char * excepInterruptedSystemCall
const char * msgPleaseOverride
const char * excepMemory
const char * excepAllocationFailed
const char * excepReallocFailed
const char * excepMath
const char * excepBufferTooSmall
const char * excepGroup
const char * excepUser
const char * excepUserNotFound
const char * excepGroupNotFound
const char * excepConditionVarWaitTimedOut
const char * excepSemaphore
const char * excepSemaphoreInitValue
const char * excepSemaphoreUnableToDestroy
const char * excepSemaphoreUnableToDecrease
const char * excepSemaphoreUnableToIncrease
const char * constNOVENDOR
const char * excepFileNotFound
const char * excepDatabaseException
const char * excepDBServerUnreachable
const char * excepAlreadyConnected2DB
const char * excepDBConnectFirst
const char * excepUndefinedClass
const char * excepString
const char * excepParse
const char * excepDateParse
const char * excepTimeParse
const char * excepBitParse
const char * excepByteParse
const char * excepNoDataFetch
const char * excepNoMoreRows
const char * excepDBConnectionFailed
const char * excepServerDisconnected
const char * excepSQLQuery
const char * excepSQLQueryRDBMSDisconnected
const char * excepUnableToParseQuery
const char * excepHostNotFound
const char * excepNSTryAgain
const char * excepNSFatal
const char * excepNoIPForYou
const char * excepConnectionResetByPeer
const String NL
const String InstallationPrefix
 X-VR2 Framework installation prefix.
const String VersionString
 X-VR2 Framework version string.
const int VersionMajor
 Version major number, look at xvr2::VersionString.
const int VersionMinor
 Version minor number, look at xvr2::VersionString.
const int VersionMicro
 Version micro number, look at xvr2::VersionString.
const int VersionPatchLevel
 Version patch level, look at xvr2::VersionString.
const String VersionMajorString
 Version major number, look at xvr2::VersionString.
const String VersionMinorString
 Version minor number, look at xvr2::VersionString.
const String VersionMicroString
 Version patch level, look at xvr2::VersionString.
const String VersionPatchLevelString
 Version patch level, look at xvr2::VersionString.


Function Documentation

template<class __ttype_x>
void xvr2::xvr2_delete ( __ttype_x &  ptr  )  [inline]

Use this function in place of the delete operator for pointers, after it has been successfully called the argument will point to the NULL (0x0) address.

Parameters:
ptr Is a reference to the dinamically allocated resource to be deleted

Definition at line 28 of file __Destruct.h.

template<class __ttype_y>
void xvr2::xvr2_delete_array ( __ttype_y &  array  )  [inline]

Use this function in place of the delete[] operator for arrays, after it has been successfully called the argument will point to the NULL (0x0) address.

Parameters:
array Is a reference to the dinamically allocated resource to be deleted

Definition at line 40 of file __Destruct.h.

const Int32 xvr2::String2Int32 ( const String &  s,
int  base = 10 
)

Converts the given string s into an Int32 value.

const Int64 xvr2::String2Int64 ( const String &  s,
int  base = 10 
)

Converts the given string s into an Int64 value.

const UInt32 xvr2::String2UInt32 ( const String &  s,
int  base = 10 
)

Converts the given string s into an UInt32 value.

const UInt64 xvr2::String2UInt64 ( const String &  s,
int  base = 10 
)

Converts the given string s into an UInt64 value.

const float xvr2::String2float ( const String &  s  ) 

Converts the given string s into a float value.

const double xvr2::String2double ( const String &  s  ) 

Converts the given string s into a double value.

const long double xvr2::String2longdouble ( const String &  s  ) 

Converts the given string s into a long double value.


Variable Documentation

Standard X-VR2 debug console.

const char* xvr2::excepAOB

const char* xvr2::excepNullPtr

const char* xvr2::excepNumeric

const char* xvr2::excepNoElem

const char* xvr2::excepNoTokens

const char* xvr2::excepGenMutex

const char* xvr2::excepGenNet

const char* xvr2::excepNetTimeout

const char* xvr2::excepNetRefused

const char* xvr2::excepNetUnreach

const char* xvr2::excepGenIO

const char* xvr2::excepBrokenPipe

const char* xvr2::excepSockUsed

const char* xvr2::excepNoFptrs

const char* xvr2::excepSysNoFptrs

const char* xvr2::excepSendFailed

const char* xvr2::excepRecvFailed

const char* xvr2::excepGenDSO

const char* xvr2::excepNoLoadDSO

const char* xvr2::excepDeadLock

const char* xvr2::excepGenThread

const char* xvr2::excepFileExists

const char* xvr2::excepFile

const char* xvr2::excepSecurity

const char* xvr2::excepFileTooBig

const char* xvr2::constDEVNULL

const char* xvr2::excepMemory

const char* xvr2::excepMath

const char* xvr2::excepGroup

const char* xvr2::excepUser

const char* xvr2::excepSemaphore

const char* xvr2::constNOVENDOR

const char* xvr2::excepString

const char* xvr2::excepParse

const char* xvr2::excepDateParse

const char* xvr2::excepTimeParse

const char* xvr2::excepBitParse

const char* xvr2::excepByteParse

const char* xvr2::excepNoMoreRows

const char* xvr2::excepSQLQuery

const char* xvr2::excepNSTryAgain

const char* xvr2::excepNSFatal

const char* xvr2::excepNoIPForYou

X-VR2 Framework installation prefix.

X-VR2 Framework version string.

The Version String might be composed of three or four numbers separed by dots, like this:
X.Y.Z.W
Where X corresponds to the version major number, Y is the minor, Z the micro and W the patch level.

const int xvr2::VersionMajor

Version major number, look at xvr2::VersionString.

const int xvr2::VersionMinor

Version minor number, look at xvr2::VersionString.

const int xvr2::VersionMicro

Version micro number, look at xvr2::VersionString.

Version patch level, look at xvr2::VersionString.

Version major number, look at xvr2::VersionString.

Version minor number, look at xvr2::VersionString.

Version patch level, look at xvr2::VersionString.

Version patch level, look at xvr2::VersionString.


Generated on Fri Jun 20 22:55:50 2008 for X-VR2 SDK by  doxygen 1.5.5