---

ost Namespace Reference

Compounds
class	AtomicCounter
	The AtomicCounter class offers thread-safe manipulation of an integer counter. atomic counter operation. 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...
struct	cistring_char_traits
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
class	Event
	The Event class implements a feature originally found in the WIN32 API; event notification. Thread synchornization on event notification. More...
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	keyMap
class	keystring
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	objCounter
class	objList
class	objMap
class	objSync
class	Pointer
class	Poller
	The poller class is used to help manage pollfd structs for use in the updated serial and socket "port" code. pollfd assistance class for port classes. More...
class	PosixThread
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	BroadcastAddress
	The broadcast address object is used to store the broadcast address for a specific subnet. More...
class	InetAddress
	The network name and address objects are all derived from a common InetAddress base class. Internet Address binary data type. More...
class	InetAddrValidator
	Classes derived from InetAddress would require an specific validator to pass to the InetAddress constructor. Abstract base class for derived inet addresses validators. More...
class	InetHostAddress
	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	InetMaskAddress
	Internet addresses used specifically as masking addresses (such as " 255.255.255.0") are held in the InetMaskAddress derived object. Internet Address Mask such as subnet masks. More...
class	InetMcastAddress
	A specialization of InetAddress that provides address validation for multicast addresses. A multicast network address. More...
class	InetMcastAddrValidator
	Class for the function object that validates multicast addresses. Validating class specialized for multicast addresses. More...
class	BaseObject
	BaseObject Base class for classes that will be persistent. 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	Engine
	Engine stream serialization of persistent classes. More...
class	Exception
	If problems happen which are fatal - expect one of these thrown at you. More...
class	Number
	A number manipulation class. number manipulation. More...
class	PersistException
class	Process
	A class for containing portable process related functions that help create portable code. Peocess wrapper class. 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	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	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
	A more natural C++ "tcpstream" class for use by non-threaded applications. C++ "fstream" style tcpstream class. 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	Thread
	Every thread of execution in an application is created by deriving a unique class from the Thread class and by implementing the Run method. base class used to derive all threads of execution. 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	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	Registration
	This manages a registration to the typemanager - attempting to remove problems with the optimisers. More...
class	iterator
	The input forward iterator for tokens. More...
struct	Define
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	Keyval
struct	Keysym
struct	_page
class	DSO
	The DSO dynamic loader class is used to load object files. Dynamic class file loader. More...
class	MappedFile
	Create and map a disk file into memory. Map a named disk file into memory. 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...
class	NoSuchElementException
	Exception thrown, if someone tried to read beyond the end of the tokens. More...
class	Pipe
	The Pipe uses system kernel buffering to hold data being passed either between two execution contexts within the same process, or between different processes. kernel buffering between processes and/or threads. More...
class	PluginGroup
	A plugin group is used to manage a chain of associated plugins. Plugin grouping class. More...
class	Dir
	A low level portable directory class. low level directory access class. More...
class	FIFOSession
	The FIFOSession produces a seperate thread which can manage a fifo stream session. More...
class	fifostream
	This class provides a few alterations to the standard fstream class for dealing with fifo devices. More...
struct	_fcb
class	ChecksumDigest
	A simple checksum digest function. checksum hash function. More...
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	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	Digest
	The digest base class is used for implementing and deriving one way hashing functions. base class for hashing services. More...
class	File
class	MD5Digest
	A md5 collection/computation accululator class. md5 hash accumulation. 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	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	StringTokenizer
	Splits delimited string into tokens. 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	ThreadGroup
	A thread grouping class for a set of server classes that may be started and stopped together as a common group. Thread grouping class for server processes. More...
class	Time
	The Time class uses a integer representation of the current time. Integer based time class. More...
class	TimedGroup
	A timed group is a scheduled entity that involves things that must be processed on some kind of interval. Timed grouping class for server processes. More...
class	TypeManager
	This class manages the types for generation of the persistent objects. Type manager for persistence engine. 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	ZNumber
Typedefs
typedef unsigned long	pos_t
typedef size_t	ccxx_size_t
typedef BaseObject *(*	NewBaseObjectFunction )(void)
typedef unsigned short	tpport_t
	Transport Protocol Ports.
typedef int	signo_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
Functions
CommandOptionParse *	makeCommandOptionParse (int argc, char **argv, char *comment, CommandOption *options=defaultCommandOptionList)
	makeCommandOptionParse will create an implementation of a CommandOptionParse object.
std::ostream &	operator<< (std::ostream &os, const InetAddress &ia)
in_addr	getaddress (const InetAddress &ia)
timespec *	getTimeout (struct timespec *spec, timeout_t timeout)
void	wait (signo_t signo)
template<typename T> const T &	abs (const T &v)
Variables
CommandOption *	defaultCommandOptionList
	This defines a linked list head pointer for all the command line options that use the default list.
Slog	slog

---

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]

struct in_addr getaddress (  const InetAddress &    ia )  [inline]

struct timespec* getTimeout (  struct timespec *    spec, timeout_t    timeout )

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.

std::ostream& operator<< (  std::ostream &    os, const InetAddress &    ia )

void wait (  signo_t    signo )

---

Variable Documentation

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.

Slog ost::slog

---