Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Examples

ost Namespace Reference


Classes

class  Assoc
 This class is used to associate (object) pointers with named strings. associate names with pointers. More...

struct  Assoc::entry
class  AtomicCounter
 The AtomicCounter class offers thread-safe manipulation of an integer counter. atomic counter operation. More...

class  BaseObject
 BaseObject Base class for classes that will be persistent. More...

class  Buffer
 The buffer class represents an IPC service that is built upon a buffer of fixed capacity that can be used to transfer objects between one or more producer and consumer threads. Producer/Consumer buffer for use between threads. More...

class  Cancellation
 A class to automatically set the thread cancellation mode of a member function. Automatic cancellation mode setting. More...

class  ChecksumDigest
 A simple checksum digest function. checksum hash function. More...

struct  cistring_char_traits
class  CommandOption
 CommandOption is the base class for all command line options. More...

class  CommandOptionArg
 Class for options with an argument e.g. More...

class  CommandOptionCollect
 It only makes sense to have a single one of these set and it is also exclusive with CommandOptionRest. CommandOption to collect parameters that are not options. More...

class  CommandOptionNoArg
 CommandOption type for flags. More...

class  CommandOptionParse
 This is the CommandOptionParse interface class. More...

class  CommandOptionRest
 It only makes sense to have a single one of these set and it is exclusive with CommandOptionCollect. CommandOption to take the rest of the command line. More...

class  CommandOptionWithArg
 Derived class of CommandOption for options that have a value associated with them. More...

class  Conditional
 A conditional variable synchcronization object for one to one and one to many signal and control events between processes. conditional. More...

class  Counter
 The counter template is used for generic objects which act as automatic counters. Automatic counter template class. More...

class  CRC16Digest
 A crc16 collection/compution hash accumulator class. crc16 computation hash. More...

class  CRC32Digest
 A crc32 collection/computation hash accumulator class. crc32 computation hash. More...

class  Date
 The Date class uses a julian date representation of the current year, month, and day. julian number based date class. More...

class  DateNumber
 A number class that manipulates a string buffer that is also a date. a number that is also a date string. More...

class  Datetime
 The Datetime class uses a julian date representation of the current year, month, and day and a integer representation of the current time. Integer based time class. More...

class  Digest
 The digest base class is used for implementing and deriving one way hashing functions. base class for hashing services. More...

class  Dir
 A low level portable directory class. low level directory access class. More...

class  DirTree
 A generic class to walk a hierarchical directory structure. Directory tree walking. More...

class  DSO
 The DSO dynamic loader class is used to load object files. Dynamic class file loader. More...

class  Engine
 Engine stream serialization of persistent classes. More...

class  Event
 The Event class implements a feature originally found in the WIN32 API; event notification. Thread synchornization on event notification. More...

class  File
struct  File::_fcb
class  FixedBuffer
 A buffer class that holds a known capacity of fixed sized objects defined during creation. producer/consumer buffer for fixed size objects. More...

class  IPV4Address
 The network name and address objects are all derived from a common IPV4Address base class. Internet Address binary data type. More...

class  IPV4Broadcast
 The broadcast address object is used to store the broadcast address for a specific subnet. More...

class  IPV4Cidr
 The CIDR class is used to support routing tables and validate address policies. Classless Internet Domain Routing. More...

class  IPV4Host
 This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket. Address of a specific Internet host machine. More...

class  IPV4Mask
 Internet addresses used specifically as masking addresses (such as " 255.255.255.0") are held in the IPV4Mask derived object. Internet Address Mask such as subnet masks. More...

class  IPV4Multicast
 A specialization of IPV4Address that provides address validation for multicast addresses. A multicast network address. More...

class  IPV4MulticastValidator
 Class for the function object that validates multicast addresses. Validating class specialized for multicast addresses. More...

class  IPV4Validator
 Classes derived from IPV4Address would require an specific validator to pass to the IPV4Address constructor. Abstract base class for derived inet addresses validators. More...

class  IPV6Address
 The network name and address objects are all derived from a common IPV6Address base class. Internet Address binary data type. More...

class  IPV6Broadcast
 The broadcast address object is used to store the broadcast address for a specific subnet. More...

class  IPV6Cidr
 The CIDR class is used to support routing tables and validate address policies. Classless Internet Domain Routing. More...

class  IPV6Host
 This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket. Address of a specific Internet host machine. More...

class  IPV6Mask
 Internet addresses used specifically as masking addresses (such as " 255.255.255.0") are held in the IPV6Mask derived object. Internet Address Mask such as subnet masks. More...

class  IPV6Multicast
 A specialization of IPV6Address that provides address validation for multicast addresses. A multicast network address. More...

class  IPV6MulticastValidator
 Class for the function object that validates multicast addresses. Validating class specialized for multicast addresses. More...

class  IPV6Validator
 Classes derived from IPV6Address would require an specific validator to pass to the IPV6Address constructor. Abstract base class for derived inet addresses validators. More...

class  IZStream
class  Keydata
 Keydata objects are used to load and hold "configuration" data for a given application. load text configuration files into keyword pairs. More...

struct  Keydata::Define
struct  Keydata::Keysym
struct  Keydata::Keyval
class  keyMap
class  LinkedDouble
 Self managed double linked list object chain. Accumulating double linked list. More...

class  LinkedSingle
 Self managed single linked list object chain. Accumulating single linked list. More...

class  Lockfile
 This class is used to create a "named" lock entity that can be used to control access to a resource between multiple processes. System-wide named lock. More...

class  MapObject
 The MapObject is a base class which can be used to make a derived class operate on a MapTable. Mappable object. More...

class  MappedFile
 Create and map a disk file into memory. Map a named disk file into memory. More...

class  MapTable
 A map table allows for entities to be mapped (hash index) onto it. Table to hold hash indexed objects. More...

class  MD5Digest
 A md5 collection/computation accululator class. md5 hash accumulation. More...

class  MemPager
 The memory pager is used to allocate cumulative memory pages for storing object specific "persistant" data that is presumed to persist during the life of a given derived object. Accumulative object memory allocator. More...

struct  MemPager::_page
class  MemPagerObject
 This class is used to create derived classes which are constructed within a memory pager pool. create objects in a memory pager. More...

class  MIMEFormData
 This is a document part type for use in submitting multipart form data to a web server. multipart document part for web form data field. More...

class  MIMEItemPart
 This is used to attach an item part to a MIME multipart document that is being streamed. item or part of a multi-part object. More...

class  MIMEMultipart
 A container class for multi-part MIME document objects which can be streamed to a std::ostream destination. container for streamable multi-part MIME documents. More...

class  MIMEMultipartForm
 The Multipart form is a MIME multipart document specific for the construction and delivery of form data to a web server through a post method. deliver form results as multipart document. More...

class  Mutex
 The Mutex class is used to protect a section of code so that at any given time only a single thread can perform the protected operation. Mutex lock for protected access. More...

class  MutexCounter
 The Mutex Counter is a counter variable which can safely be incremented or decremented by multiple threads. Thread protected integer counter. More...

class  MutexLock
 The MutexLock class is used to protect a section of code so that at any given time only a single thread can perform the protected operation. Mutex automatic locker for protected access. More...

class  NetworkDeviceInfo
 Network device information class. More...

class  Number
 A number manipulation class. number manipulation. More...

class  objCounter
 Generic template class for creating classes which maintain an active count of the number of instances currently in active use. Object instance global reference count. More...

class  objList
 Used to create and manage a single linked list of objects of a common type. single linked list searchable template chain. More...

class  objMap
 Used to create and manage a hash index of objects through a common type. hash indexed searchable template chain. More...

class  objSync
 Generic template to create objects of a common base type which share a static mutex so that all instances of the class have a global lock. global mutex locked class. More...

class  OZStream
class  Pointer
 Used to create and manage referece counted pointers. reference counted pointer template. More...

class  PosixThread
class  Process
 A class for containing portable process related functions that help create portable code. Peocess wrapper class. More...

class  RandomFile
 The purpose of this class is to define a base class for low level random file access that is portable between Win32 and Posix systems. Portable random disk file access. More...

class  ReadLock
 The ReadLock class is used to protect a section of code through a ThreadLock for "read" access to the member function. Read mode automatic locker for protected access. More...

class  RefObject
 A reference countable object. Object managed by smart pointer reference count. More...

class  RefPointer
 Pointer to reference counted objects. Pointer to reference count managed objects. More...

class  Runable
 A container for objects that can be queued against a runlist. runable object with notify when ready. More...

class  Runlist
 A runlist is used to restrict concurrent exection to a limited set of concurrent sessions, much like a semaphore. list of runable objects. More...

class  Semaphore
 A semaphore is generally used as a synchronization object between multiple threads or to protect a limited and finite resource such as a memory or thread pool. Semaphore counter for thread synchronization. More...

class  SemaphoreLock
 The SemaphoreLock class is used to protect a section of code through a semaphore so that only x instances of the member function may execute concurrently. Semaphore automatic locker for protected access. More...

class  Serial
 The Serial class is used as the base for all serial I/O services under APE. base class for all serial I/O services. More...

class  SerialPort
 The serial port is an internal class which is attached to and then serviced by a specified SerialService thread. base class for thread pool serviced serial I/O. More...

class  SerialService
 The SerialService is a thead service object that is meant to service attached serial ports. Thread pool service for serial ports. More...

class  SharedFile
 This class defines a database I/O file service that can be shared by multiple processes. This class defines a database I/O file service that can be shared by multiple processes. More...

class  SharedMemPager
 The shared mempager uses a mutex to protect key access methods. mutex protected memory pager. More...

class  SimpleTCPStream
 Simple TCP Stream, to be used with Common C++ Library. More...

class  Slog
 The slog class is used to stream messages to the system's logging facility (syslogd). system logging facility class. More...

class  Socket
 The Socket is used as the base for all Internet protocol services under Common C++. base class of all sockets. More...

class  SocketPort
 The socket port is an internal class which is attached to and then serviced by a specific SocketService "object". base class for realtime and thread pool serviced protocols. More...

class  SocketService
 The SocketService is a thread pool object that is meant to service attached socket ports. Thread pool service object for socket ports. More...

class  SSLStream
class  SString
class  StackPager
 The StackPager provides a repository to stash and retrieve working data in last-in-first-out order. last in first out object pager. More...

struct  StackPager::frame
class  String
 This is a generic and portable string class. Generic string class. More...

class  StringObject
 The StringObject class is used to derive subclasses that use the String managed memory pool for all space allocations by overriding new and delete operators. Objects managed in reusable String memory pools. More...

class  StringTokenizer
 Splits delimited string into tokens. More...

class  StringTokenizer::iterator
 The input forward iterator for tokens. More...

class  StringTokenizer::NoSuchElementException
 Exception thrown, if someone tried to read beyond the end of the tokens. More...

class  SysTime
 This class is used to access non-reentrant date and time functions in the standard C library. Thread safe date and time functions. More...

class  TCPSession
 The TCP session is used to primarily to represent a client connection that can be managed on a seperate thread. Threaded streamable socket with non-blocking constructor. More...

class  TCPSocket
 TCP sockets are used for stream based connected sessions between two sockets. bound server for TCP streams and sessions. More...

class  TCPStream
 TCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections. streamable TCP socket connection. More...

class  TCPV6Socket
 TCPV6 sockets are used for stream based connected sessions between two ipv6 sockets. bound server for TCP streams and sessions. More...

class  Thread
 Every thread of execution in an application is created by instantiating an object of a class derived from the Thread class. base class used to derive all threads of execution. More...

class  ThreadFile
 This class defines a database I/O file service that can be shared by multiple threads. This class defines a database I/O file service that can be shared by multiple threads. More...

class  ThreadKey
 This class allows the creation of a thread context unique "pointer" that can be set and retrieved and can be used to create thread specific data areas for implementing "thread safe" library routines. container for thread specific data storage. More...

class  ThreadLock
 The ThreadLock class impliments a thread rwlock for optimal reader performance on systems which have rwlock support, and reverts to a simple mutex for those that do not. Posix rwlock extension for protected access. More...

class  ThreadQueue
 Somewhat generic queue processing class to establish a producer consumer queue. in memory data queue interface. More...

struct  ThreadQueue::_data
class  Time
 The Time class uses a integer representation of the current time. Integer based time class. More...

class  TimerPort
 Timer ports are used to provide synchronized timing events when managed under a "service thread" such as SocketService. synchronized millisecond timing for service threads. More...

class  TTYSession
 The TTYSession aggragates a TTYStream and a Common C++ Thread which is assumed to be the execution context that will be used to perform actual I/O operations. This class is very anagolous to TCPSession. More...

class  ttystream
 A more natural C++ "ttystream" class for use by non-threaded applications. C++ "fstream" style ttystream class. More...

class  TTYStream
 TTY streams are used to represent serial connections that are fully "streamable" objects using C++ stream classes and friends. streamable tty serial I/O class. More...

class  TypeManager
 This class manages the types for generation of the persistent objects. Type manager for persistence engine. More...

class  TypeManager::Registration
 This manages a registration to the typemanager - attempting to remove problems with the optimisers. More...

class  UDPBroadcast
 Representing a UDP socket used for subnet broadcasts, this class provides an alternate binding and setPeer() capability for UDP sockets. Unreliable Datagram for subnet broadcasts. More...

class  UDPDuplex
 UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts. Unreliable Datagram Peer Associations. More...

class  UDPReceive
 Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet. Unreliable Datagram Peer Associations. More...

class  UDPSocket
 UDP sockets implement the TCP SOCK_DGRAM UDP protocol. Unreliable Datagram Protocol sockets. More...

class  UDPTransmit
 Representing half of a two-way UDP connection, the UDP transmitter can broadcast data to another selected peer host or to an entire subnet. Unreliable Datagram Peer Associations. More...

class  UnixSession
 The Unix domain session is used to primarily to represent a client connection that can be managed on a seperate thread. Threaded streamable unix domain socket with non-blocking constructor. More...

class  UnixSocket
 Unix domain sockets are used for stream based connected sessions between processes on the same machine. bound server for Unix domain streams and sessions. More...

class  unixstream
 A more natural C++ "unixstream" class for use by non-threaded applications. C++ "fstream" style unixstream class. More...

class  UnixStream
 Unix streams are used to represent Unix domain client connections to a local server for accepting client connections. streamable Unix domain socket connection. More...

class  URLStream
 A URL processing version of TCPStream. C++ url processing stream class. More...

class  WriteLock
 The WriteLock class is used to protect a section of code through a ThreadLock for "write" access to the member function. Read mode automatic locker for protected access. More...

class  XMLRPC
 This class impliments a core XMLRPC service without the underlying transports. XML-RPC service building class. More...

class  XMLStream
 This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods. XML Stream Parser (SAX). More...

class  ZNumber

Typedefs

typedef unsigned short tpport_t
 Transport Protocol Ports.

typedef unsigned long pos_t
typedef size_t ccxx_size_t
typedef std::string_char_traits<
char > 
cstring_char_traits
typedef std::basic_string<
char > 
cstring
typedef std::basic_string<
char, cistring_char_traits<
char > > 
cistring
typedef BaseObject *(* NewBaseObjectFunction )(void)
typedef int signo_t

Functions

__EXPORT std::ostream & operator<< (std::ostream &os, const IPV4Address &ia)
in_addr getaddress (const IPV4Address &ia)
__EXPORT std::ostream & operator<< (std::ostream &os, const IPV6Address &ia)
in6_addr getaddress (const IPV6Address &ia)
__EXPORT CommandOptionParsemakeCommandOptionParse (int argc, char **argv, char *comment, CommandOption *options=defaultCommandOptionList)
 makeCommandOptionParse will create an implementation of a CommandOptionParse object.

template<typename T> const T & abs (const T &v)
__EXPORT void * memmove (char *dest, const char *source, size_t length)
__EXPORT char * strdup (const char *str)
__EXPORT int lockf (int fd, int mode, long offset)
char * strtok_r (char *s, const char *d, char **x)\
__EXPORT char * lsetField (char *target, size_t size, const char *src, const char fill=0)
__EXPORT char * rsetField (char *target, size_t size, const char *src, const char fill=0)
__EXPORT char * setString (char *target, size_t size, const char *src)
__EXPORT char * addString (char *target, size_t size, const char *src)
__EXPORT char * newString (const char *src, size_t size=0)
__EXPORT void delString (char *str)
__EXPORT char * setUpper (char *string, size_t size)
__EXPORT char * setLower (char *string, size_t size)
__EXPORT char * find (const char *cs, char *str, size_t len=0)
__EXPORT char * rfind (const char *cs, char *str, size_t len=0)
__EXPORT char * ifind (const char *cs, char *str, size_t len=0)
__EXPORT char * strip (const char *cs, char *str, size_t len=0)
__EXPORT size_t strchop (const char *cs, char *str, size_t len=0)
__EXPORT size_t strtrim (const char *cs, char *str, size_t len=0)
char * dupString (const char *src, size_t size=0)
timespec * getTimeout (struct timespec *spec, timeout_t timeout)
void wait (signo_t signo)
ThreadgetThread (void)
tm * localtime_r (const time_t *t, struct tm *b)
char * ctime_r (const time_t *t, char *buf)
tm * gmtime_r (const time_t *t, struct tm *b)\
char * asctime_r (const struct tm *tm, char *b)\

Variables

__EXPORT IPV4Host
__EXPORT IPV6Host
__EXPORT CommandOptiondefaultCommandOptionList
 This defines a linked list head pointer for all the command line options that use the default list.

__EXPORT MIMEMultipart
__EXPORT MIMEItemPart
__EXPORT Runlist
__EXPORT Runable
__EXPORT MapObject
__EXPORT SerialPort
__EXPORT SerialService
__EXPORT Slog slog
__EXPORT SimpleTCPStream
__EXPORT SocketPort
__EXPORT SocketService
__EXPORT Thread
__EXPORT ThreadKey
__EXPORT Conditional
__EXPORT Event


Typedef Documentation

typedef size_t ost::ccxx_size_t
 

typedef std::basic_string<char, cistring_char_traits<char> > ost::cistring
 

typedef std::basic_string<char> ost::cstring
 

typedef std::string_char_traits<char> ost::cstring_char_traits
 

typedef class BaseObject*(* ost::NewBaseObjectFunction)(void)
 

typedef unsigned long ost::pos_t
 

typedef int ost::signo_t
 

typedef unsigned short ost::tpport_t
 

Transport Protocol Ports.


Function Documentation

template<typename T>
const T& abs const T &  v  )  [inline]
 

__EXPORT char* addString char *  target,
size_t  size,
const char *  src
 

char* asctime_r const struct tm *  tm,
char *  b
[inline]
 

char* ctime_r const time_t *  t,
char *  buf
[inline]
 

__EXPORT void delString char *  str  ) 
 

char* dupString const char *  src,
size_t  size = 0
[inline]
 

__EXPORT char* find const char *  cs,
char *  str,
size_t  len = 0
 

struct in6_addr getaddress const IPV6Address &  ia  )  [inline]
 

struct in_addr getaddress const IPV4Address &  ia  )  [inline]
 

Thread* getThread void   )  [inline]
 

struct timespec* getTimeout struct timespec *  spec,
timeout_t  timeout
 

struct tm* gmtime_r const time_t *  t,
struct tm *  b
[inline]
 

__EXPORT char* ifind const char *  cs,
char *  str,
size_t  len = 0
 

struct tm* localtime_r const time_t *  t,
struct tm *  b
[inline]
 

__EXPORT int lockf int  fd,
int  mode,
long  offset
 

__EXPORT char* lsetField char *  target,
size_t  size,
const char *  src,
const char  fill = 0
 

__EXPORT CommandOptionParse* makeCommandOptionParse int  argc,
char **  argv,
char *  comment,
CommandOption *  options = defaultCommandOptionList
 

makeCommandOptionParse will create an implementation of a CommandOptionParse object.

This particular implementation is a wrapper around getopt_long(3). That interface unfortunatly does not provide enough information to give the best error messages with malformed input. If the implementation changes there is a good chance that the binary interface will remain the same.

__EXPORT void* memmove char *  dest,
const char *  source,
size_t  length
 

__EXPORT char* newString const char *  src,
size_t  size = 0
 

__EXPORT std::ostream& operator<< std::ostream &  os,
const IPV6Address &  ia
 

__EXPORT std::ostream& operator<< std::ostream &  os,
const IPV4Address &  ia
 

__EXPORT char* rfind const char *  cs,
char *  str,
size_t  len = 0
 

__EXPORT char* rsetField char *  target,
size_t  size,
const char *  src,
const char  fill = 0
 

__EXPORT char* setLower char *  string,
size_t  size
 

__EXPORT char* setString char *  target,
size_t  size,
const char *  src
 

__EXPORT char* setUpper char *  string,
size_t  size
 

__EXPORT size_t strchop const char *  cs,
char *  str,
size_t  len = 0
 

__EXPORT char* strdup const char *  str  ) 
 

__EXPORT char* strip const char *  cs,
char *  str,
size_t  len = 0
 

char* strtok_r char *  s,
const char *  d,
char **  x
[inline]
 

__EXPORT size_t strtrim const char *  cs,
char *  str,
size_t  len = 0
 

void wait signo_t  signo  ) 
 


Variable Documentation

class __EXPORT ost::Conditional
 

__EXPORT CommandOption* ost::defaultCommandOptionList
 

This defines a linked list head pointer for all the command line options that use the default list.

It will most likely be used in most cases without being explicitly referenced in application code. It is a default value of various method's parameters.

class __EXPORT ost::Event
 

class __EXPORT ost::IPV4Host
 

class __EXPORT ost::IPV6Host
 

class __EXPORT ost::MapObject
 

class __EXPORT ost::MIMEItemPart
 

class __EXPORT ost::MIMEMultipart
 

class __EXPORT ost::Runable
 

class __EXPORT ost::Runlist
 

class __EXPORT ost::SerialPort
 

class __EXPORT ost::SerialService
 

class __EXPORT ost::SimpleTCPStream
 

__EXPORT Slog ost::slog
 

class __EXPORT ost::SocketPort
 

class __EXPORT ost::SocketService
 

class __EXPORT ost::Thread
 

class __EXPORT ost::ThreadKey
 


Generated on Sat May 12 18:24:17 2007 for GNU CommonC++ by doxygen 1.3.5