Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members  

ost Namespace Reference


Compounds

struct  ost::_fcb
struct  ost::_keysym
struct  ost::_keyval
struct  ost::MemPager::_page
class  ost::AtomicCounter
 The AtomicCounter class offers thread-safe manipulation of an integer counter. atomic counter operation. More...

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

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

class  ost::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  ost::ChecksumDigest
 A simple checksum digest function. checksum hash function. More...

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

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

class  ost::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  ost::CommandOptionNoArg
 CommandOption type for flags. More...

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

class  ost::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  ost::CommandOptionWithArg
 Derived class of CommandOption for options that have a value associated with them. More...

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

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

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

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

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

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

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

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

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

class  ost::Engine::Exception
 If problems happen which are fatal - expect one of these thrown at you. More...

class  ost::FIFOSession
 The FIFOSession produces a seperate thread which can manage a fifo stream session. More...

class  ost::fifostream
 This class provides a few alterations to the standard fstream class for dealing with fifo devices. More...

class  ost::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  ost::InetAddress
 The network name and address objects are all derived from a common InetAddress base class. Internet Address binary data type. More...

class  ost::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  ost::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  ost::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  ost::InetMcastAddress
 A specialization of InetAddress that provides address validation for multicast addresses. A multicast network address. More...

class  ost::InetMcastAddrValidator
 Class for the function object that validates multicast addresses. Validating class specialized for multicast addresses. More...

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

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

struct  ost::KEYDEF
class  ost::keyMap
class  ost::keystring
class  ost::MappedFile
 Create and map a disk file into memory. Map a named disk file into memory. More...

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

class  ost::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  ost::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  ost::MutexCounter
 The Mutex Counter is a counter variable which can safely be incremented or decremented by multiple threads. Thread protected integer counter. More...

class  ost::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  ost::StringTokenizer::NoSuchElementException
 Exception thrown, if someone tried to read beyond the end of the tokens. More...

class  ost::Number
 A number manipulation class. number manipulation. More...

class  ost::objList
class  ost::objMap
class  ost::PersistException
class  ost::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  ost::PluginGroup
 A plugin group is used to manage a chain of associated plugins. Plugin grouping class. More...

class  ost::Pointer
class  ost::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  ost::PosixThread
class  ost::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  ost::TypeManager::Registration
 This manages a registration to the typemanager - attempting to remove problems with the optimisers. More...

class  ost::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  ost::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  ost::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  ost::SerialService
 The SerialService is a thead service object that is meant to service attached serial ports. Thread pool service for serial ports. More...

class  ost::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  ost::SharedMemPager
 The shared mempager uses a mutex to protect key access methods. mutex protected memory pager. More...

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

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

class  ost::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  ost::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  ost::StringTokenizer
 Splits delimited string into tokens. More...

class  ost::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  ost::TCPSocket
 TCP sockets are used for stream based connected sessions between two sockets. bound server for TCP streams and sessions. More...

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

class  ost::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  ost::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  ost::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  ost::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  ost::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  ost::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  ost::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  ost::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  ost::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  ost::ttystream
 A more natural C++ "ttystream" class for use by non-threaded applications. C++ "fstream" style ttystream class. More...

class  ost::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  ost::TypeManager
 This class manages the types for generation of the persistent objects. Type manager for persistence engine. More...

class  ost::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  ost::UDPDuplex
 UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts. Unreliable Datagram Peer Associations. More...

class  ost::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  ost::UDPSocket
 UDP sockets implement the TCP SOCK_DGRAM UDP protocol. Unreliable Datagram Protocol sockets. More...

class  ost::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  ost::URLStream
 A URL processing version of TCPStream. C++ url processing stream class. More...

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

class  ost::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  ost::ZNumber

Typedefs

typedef unsigned long pos_t
typedef size_t ccxx_size_t
typedef enum fileattr_t fileattr_t
typedef enum fileerror_t fileerror_t
typedef enum fileaccess_t fileaccess_t
typedef enum filecomplete_t filecomplete_t
typedef BaseObject *(* NewBaseObjectFunction )(void)
typedef enum sioerror_t sioerror_t
typedef enum sioflow_t sioflow_t
typedef enum sioparity_t sioparity_t
typedef enum siopend_t siopend_t
typedef enum slog_class_t slog_class_t
typedef enum slog_level_t slog_level_t
typedef enum sockstate_t sockstate_t
typedef enum sockerror_t sockerror_t
typedef enum socktos_t socktos_t
typedef enum sockpend_t sockpend_t
typedef unsigned short tpport_t
 Transport Protocol Ports. More...

typedef enum throw_t throw_t
typedef enum thread_cancel_t thread_cancel_t
typedef enum thread_suspend_t thread_suspend_t
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
cistring

Enumerations

enum  {
  FILE_OPEN_READONLY = O_RDONLY, FILE_OPEN_WRITEONLY = O_WRONLY, FILE_OPEN_READWRITE = O_RDWR, FILE_OPEN_APPEND = O_WRONLY | O_APPEND,
  FILE_OPEN_SYNC = O_RDWR, FILE_OPEN_TRUNCATE
}
enum  fileattr_t { FILE_ATTR_INVALID = 0, FILE_ATTR_PRIVATE = 0400 | 0200 , FILE_ATTR_GROUP = FILE_ATTR_PRIVATE | 0040 | 0020 , FILE_ATTR_PUBLIC }
enum  fileerror_t {
  FILE_SUCCESS = 0, FILE_NOT_OPENED, FILE_MAP_FAILED, FILE_INIT_FAILED,
  FILE_OPEN_DENIED, FILE_OPEN_FAILED, FILE_OPEN_INUSE, FILE_READ_INTERRUPTED,
  FILE_READ_INCOMPLETE, FILE_READ_FAILURE, FILE_WRITE_INTERRUPTED, FILE_WRITE_INCOMPLETE,
  FILE_WRITE_FAILURE, FILE_EXTENDED_ERROR
}
enum  fileaccess_t { FILE_ACCESS_READONLY = O_RDONLY, FILE_ACCESS_WRITEONLY = O_WRONLY, FILE_ACCESS_READWRITE }
enum  filecomplete_t { FILE_COMPLETION_IMMEDIATE, FILE_COMPLETION_DELAYED, FILE_COMPLETION_DEFERRED }
enum  sioerror_t {
  SERIAL_SUCCESS = 0, SERIAL_OPEN_NOTTY, SERIAL_OPEN_FAILED, SERIAL_SPEED_INVALID,
  SERIAL_FLOW_INVALID, SERIAL_PARITY_INVALID, SERIAL_CHARSIZE_INVALID, SERIAL_STOPBITS_INVALID,
  SERIAL_OPTION_INVALID, SERIAL_RESOURCE_FAILURE, SERIAL_OUTPUT_ERROR, SERIAL_INPUT_ERROR,
  SERIAL_TIMEOUT_ERROR, SERIAL_EXTENDED_ERROR
}
enum  sioflow_t { SERIAL_FLOW_NONE, SERIAL_FLOW_SOFT, SERIAL_FLOW_HARD, SERIAL_FLOW_BOTH }
enum  sioparity_t { SERIAL_PARITY_NONE, SERIAL_PARITY_ODD, SERIAL_PARITY_EVEN }
enum  siopend_t { SERIAL_PENDING_INPUT, SERIAL_PENDING_OUTPUT, SERIAL_PENDING_ERROR }
enum  slog_class_t {
  SLOG_SECURITY, SLOG_AUDIT, SLOG_DAEMON, SLOG_USER,
  SLOG_DEFAULT, SLOG_LOCAL0, SLOG_LOCAL1, SLOG_LOCAL2,
  SLOG_LOCAL3, SLOG_LOCAL4, SLOG_LOCAL5, SLOG_LOCAL6,
  SLOG_LOCAL7
}
enum  slog_level_t {
  SLOG_EMERGENCY = 1, SLOG_ALERT, SLOG_CRITICAL, SLOG_ERROR,
  SLOG_WARNING, SLOG_NOTICE, SLOG_INFO, SLOG_DEBUG
}
enum  sockstate_t {
  SOCKET_INITIAL, SOCKET_AVAILABLE, SOCKET_BOUND, SOCKET_CONNECTED,
  SOCKET_CONNECTING, SOCKET_STREAM
}
 used to enumerate type of socket I/O blocking - or non blocking. More...

enum  sockerror_t {
  SOCKET_SUCCESS = 0, SOCKET_CREATE_FAILED, SOCKET_COPY_FAILED, SOCKET_INPUT_ERROR,
  SOCKET_INPUT_INTERRUPT, SOCKET_RESOURCE_FAILURE, SOCKET_OUTPUT_ERROR, SOCKET_OUTPUT_INTERRUPT,
  SOCKET_NOT_CONNECTED, SOCKET_CONNECT_REFUSED, SOCKET_CONNECT_REJECTED, SOCKET_CONNECT_TIMEOUT,
  SOCKET_CONNECT_FAILED, SOCKET_CONNECT_INVALID, SOCKET_CONNECT_BUSY, SOCKET_CONNECT_NOROUTE,
  SOCKET_BINDING_FAILED, SOCKET_BROADCAST_DENIED, SOCKET_ROUTING_DENIED, SOCKET_KEEPALIVE_DENIED,
  SOCKET_SERVICE_DENIED, SOCKET_SERVICE_UNAVAILABLE, SOCKET_MULTICAST_DISABLED, SOCKET_TIMEOUT_ERROR,
  SOCKET_NODELAY_ERROR, SOCKET_EXTENDED_ERROR
}
enum  socktos_t {
  SOCKET_IPTOS_LOWDELAY, SOCKET_IPTOS_THROUGHPUT, SOCKET_IPTOS_RELIABILITY, SOCKET_IPTOS_MINCOST,
  SOCKET_IPTOS_INVALID
}
enum  sockpend_t { SOCKET_PENDING_INPUT, SOCKET_PENDING_OUTPUT, SOCKET_PENDING_ERROR }
enum  throw_t { THROW_NOTHING, THROW_OBJECT, THROW_EXCEPTION }
enum  thread_cancel_t {
  THREAD_CANCEL_INITIAL = 0, THREAD_CANCEL_DEFERRED = 1, THREAD_CANCEL_IMMEDIATE, THREAD_CANCEL_DISABLED,
  THREAD_CANCEL_DEFAULT
}
enum  thread_suspend_t { THREAD_SUSPEND_ENABLE, THREAD_SUSPEND_DISABLE }
enum  urlerror_t {
  URL_SUCCESS = 0, URL_UNREACHABLE, URL_MISSING, URL_DENIED,
  URL_INVALID, URL_FORBIDDEN, URL_UNAUTHORIZED, URL_RELOCATED,
  URL_FAILURE, URL_TIMEOUT
}
enum  urlauth_t { URL_ANONYMOUS_AUTH = 0, URL_BASIC_AUTH }
enum  urlencoding_t { URL_BINARY_ENCODING = 0, URL_CHUNKED_ENCODING }
enum  urlmethod_t {
  HTTP_GET_METHOD, HTTP_PUT_METHOD, HTTP_POST_METHOD, FTP_GET_METHOD,
  FTP_PUT_METHOD, FILE_GET_METHOD, FILE_PUT_METHOD
}
enum  urlprotocol_t { HTTP_PROTOCOL_1_0, HTTP_PROTOCOL_1_1 }

Functions

CommandOptionParseMakeCommandOptionParse (int argc, char **argv, char *comment, CommandOption *options=DefaultCommandOptionList)
 MakeCommandOptionParse will create an implementation of a CommandOptionParse object. More...

bool isDir (const char *path)
bool isFile (const char *path)
bool isDevice (const char *path)
bool canAccess (const char *path)
bool canModify (const char *path)
Engineoperator>> (Engine &ar, BaseObject *&ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, BaseObject const *ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, int8 &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, int8 ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, uint8 &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, uint8 ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, int16 &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, int16 ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, uint16 &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, uint16 ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, int32 &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, int32 ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, uint32 &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, uint32 ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, int64 &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, int64 ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, uint64 &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, uint64 ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, float &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, float ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, double &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, double ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, std::string &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, std::string ob) throw ( Engine::Exception )
Engineoperator>> (Engine &ar, bool &ob) throw ( Engine::Exception )
Engineoperator<< (Engine &ar, bool ob) throw ( Engine::Exception )
template<class T> Engineoperator<< (Engine &ar, std::vector< T > const &ob) throw ( Engine::Exception )
 serialize a vector of some serializable content to the engine. More...

template<class T> Engineoperator>> (Engine &ar, std::vector< T > &ob) throw ( Engine::Exception )
 deserialize a vector of deserializable content from an engine. More...

template<class Key, class Value> Engineoperator<< (Engine &ar, std::map< Key, Value > const &ob) throw ( Engine::Exception )
 serialize a map with keys/values which both are serializeable to an engine. More...

template<class Key, class Value> Engineoperator>> (Engine &ar, std::map< Key, Value > &ob) throw ( Engine::Exception )
 deserialize a map with keys/values which both are serializeable from an engine. More...

std::ostreamoperator<< (std::ostream &os, const InetAddress &ia)
in_addr getaddress (const InetAddress &ia)
void execHandler (Thread *th)
ThreadgetThread (void)
throw_t getException (void)
void setException (throw_t mode)
void ccxx_sleep (timeout_t msec)
void ccxx_yield (void)
void sigHandler (int signo)
int get (Buffer &b, void *o)
int put (Buffer &b, void *o)
int peek (Buffer &b, void *o)
timespec * gettimeout (struct timespec *spec, timeout_t timeout)
void wait (signo_t signo)
void pdetach (void)
 This function provides a simple and portable means to fork/detach a process into a daemon. This function provides a simple and portable means to fork/detach a process into a daemon. More...

char * urldecode (char *source, char *dest=NULL)
char * urlencode (const char *source, char *dest, unsigned size)
char * b64decode (char *source, char *dest=NULL)
char * b64encode (const char *source, char *dest, unsigned size)
template<typedef T> const T & abs (const T &v)
 objCounter ()
virtual ~objCounter ()

Variables

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

ost::_fcb fcb_t
ost::_keyval keyval_t
ost::_keysym keysym_t
Slog slog
objCounter protected static
unsigned 
objCount


Typedef Documentation

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

typedef size_t ost::ccxx_size_t
 

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

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

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

typedef enum fileaccess_t ost::fileaccess_t
 

typedef enum fileattr_t ost::fileattr_t
 

typedef enum filecomplete_t ost::filecomplete_t
 

typedef enum fileerror_t ost::fileerror_t
 

typedef unsigned long ost::pos_t
 

typedef int ost::signo_t
 

typedef enum sioerror_t ost::sioerror_t
 

typedef enum sioflow_t ost::sioflow_t
 

typedef enum sioparity_t ost::sioparity_t
 

typedef enum siopend_t ost::siopend_t
 

typedef enum slog_class_t ost::slog_class_t
 

typedef enum slog_level_t ost::slog_level_t
 

typedef enum sockerror_t ost::sockerror_t
 

typedef enum sockpend_t ost::sockpend_t
 

typedef enum sockstate_t ost::sockstate_t
 

typedef enum socktos_t ost::socktos_t
 

typedef enum thread_cancel_t ost::thread_cancel_t
 

typedef enum thread_suspend_t ost::thread_suspend_t
 

typedef enum throw_t ost::throw_t
 

typedef unsigned short ost::tpport_t
 

Transport Protocol Ports.


Enumeration Type Documentation

anonymous enum
 

Enumeration values:
FILE_OPEN_READONLY  
FILE_OPEN_WRITEONLY  
FILE_OPEN_READWRITE  
FILE_OPEN_APPEND  
FILE_OPEN_SYNC  
FILE_OPEN_TRUNCATE  

enum ost::fileaccess_t
 

Enumeration values:
FILE_ACCESS_READONLY  
FILE_ACCESS_WRITEONLY  
FILE_ACCESS_READWRITE  

enum ost::fileattr_t
 

Enumeration values:
FILE_ATTR_INVALID  
FILE_ATTR_PRIVATE  
FILE_ATTR_GROUP  
FILE_ATTR_PUBLIC  

enum ost::filecomplete_t
 

Enumeration values:
FILE_COMPLETION_IMMEDIATE  
FILE_COMPLETION_DELAYED  
FILE_COMPLETION_DEFERRED  

enum ost::fileerror_t
 

Enumeration values:
FILE_SUCCESS  
FILE_NOT_OPENED  
FILE_MAP_FAILED  
FILE_INIT_FAILED  
FILE_OPEN_DENIED  
FILE_OPEN_FAILED  
FILE_OPEN_INUSE  
FILE_READ_INTERRUPTED  
FILE_READ_INCOMPLETE  
FILE_READ_FAILURE  
FILE_WRITE_INTERRUPTED  
FILE_WRITE_INCOMPLETE  
FILE_WRITE_FAILURE  
FILE_EXTENDED_ERROR  

enum ost::sioerror_t
 

Enumeration values:
SERIAL_SUCCESS  
SERIAL_OPEN_NOTTY  
SERIAL_OPEN_FAILED  
SERIAL_SPEED_INVALID  
SERIAL_FLOW_INVALID  
SERIAL_PARITY_INVALID  
SERIAL_CHARSIZE_INVALID  
SERIAL_STOPBITS_INVALID  
SERIAL_OPTION_INVALID  
SERIAL_RESOURCE_FAILURE  
SERIAL_OUTPUT_ERROR  
SERIAL_INPUT_ERROR  
SERIAL_TIMEOUT_ERROR  
SERIAL_EXTENDED_ERROR  

enum ost::sioflow_t
 

Enumeration values:
SERIAL_FLOW_NONE  
SERIAL_FLOW_SOFT  
SERIAL_FLOW_HARD  
SERIAL_FLOW_BOTH  

enum ost::sioparity_t
 

Enumeration values:
SERIAL_PARITY_NONE  
SERIAL_PARITY_ODD  
SERIAL_PARITY_EVEN  

enum ost::siopend_t
 

Enumeration values:
SERIAL_PENDING_INPUT  
SERIAL_PENDING_OUTPUT  
SERIAL_PENDING_ERROR  

enum ost::slog_class_t
 

Enumeration values:
SLOG_SECURITY  
SLOG_AUDIT  
SLOG_DAEMON  
SLOG_USER  
SLOG_DEFAULT  
SLOG_LOCAL0  
SLOG_LOCAL1  
SLOG_LOCAL2  
SLOG_LOCAL3  
SLOG_LOCAL4  
SLOG_LOCAL5  
SLOG_LOCAL6  
SLOG_LOCAL7  

enum ost::slog_level_t
 

Enumeration values:
SLOG_EMERGENCY  
SLOG_ALERT  
SLOG_CRITICAL  
SLOG_ERROR  
SLOG_WARNING  
SLOG_NOTICE  
SLOG_INFO  
SLOG_DEBUG  

enum ost::sockerror_t
 

Enumeration values:
SOCKET_SUCCESS  
SOCKET_CREATE_FAILED  
SOCKET_COPY_FAILED  
SOCKET_INPUT_ERROR  
SOCKET_INPUT_INTERRUPT  
SOCKET_RESOURCE_FAILURE  
SOCKET_OUTPUT_ERROR  
SOCKET_OUTPUT_INTERRUPT  
SOCKET_NOT_CONNECTED  
SOCKET_CONNECT_REFUSED  
SOCKET_CONNECT_REJECTED  
SOCKET_CONNECT_TIMEOUT  
SOCKET_CONNECT_FAILED  
SOCKET_CONNECT_INVALID  
SOCKET_CONNECT_BUSY  
SOCKET_CONNECT_NOROUTE  
SOCKET_BINDING_FAILED  
SOCKET_BROADCAST_DENIED  
SOCKET_ROUTING_DENIED  
SOCKET_KEEPALIVE_DENIED  
SOCKET_SERVICE_DENIED  
SOCKET_SERVICE_UNAVAILABLE  
SOCKET_MULTICAST_DISABLED  
SOCKET_TIMEOUT_ERROR  
SOCKET_NODELAY_ERROR  
SOCKET_EXTENDED_ERROR  

enum ost::sockpend_t
 

Enumeration values:
SOCKET_PENDING_INPUT  
SOCKET_PENDING_OUTPUT  
SOCKET_PENDING_ERROR  

enum ost::sockstate_t
 

used to enumerate type of socket I/O blocking - or non blocking.

Enumeration values:
SOCKET_INITIAL  
SOCKET_AVAILABLE  
SOCKET_BOUND  
SOCKET_CONNECTED  
SOCKET_CONNECTING  
SOCKET_STREAM  

enum ost::socktos_t
 

Enumeration values:
SOCKET_IPTOS_LOWDELAY  
SOCKET_IPTOS_THROUGHPUT  
SOCKET_IPTOS_RELIABILITY  
SOCKET_IPTOS_MINCOST  
SOCKET_IPTOS_INVALID  

enum ost::thread_cancel_t
 

Enumeration values:
THREAD_CANCEL_INITIAL  
THREAD_CANCEL_DEFERRED  
THREAD_CANCEL_IMMEDIATE  
THREAD_CANCEL_DISABLED  
THREAD_CANCEL_DEFAULT  

enum ost::thread_suspend_t
 

Enumeration values:
THREAD_SUSPEND_ENABLE  
THREAD_SUSPEND_DISABLE  

enum ost::throw_t
 

Enumeration values:
THROW_NOTHING  
THROW_OBJECT  
THROW_EXCEPTION  

enum ost::urlauth_t
 

Enumeration values:
URL_ANONYMOUS_AUTH  
URL_BASIC_AUTH  

enum ost::urlencoding_t
 

Enumeration values:
URL_BINARY_ENCODING  
URL_CHUNKED_ENCODING  

enum ost::urlerror_t
 

Enumeration values:
URL_SUCCESS  
URL_UNREACHABLE  
URL_MISSING  
URL_DENIED  
URL_INVALID  
URL_FORBIDDEN  
URL_UNAUTHORIZED  
URL_RELOCATED  
URL_FAILURE  
URL_TIMEOUT  

enum ost::urlmethod_t
 

Enumeration values:
HTTP_GET_METHOD  
HTTP_PUT_METHOD  
HTTP_POST_METHOD  
FTP_GET_METHOD  
FTP_PUT_METHOD  
FILE_GET_METHOD  
FILE_PUT_METHOD  

enum ost::urlprotocol_t
 

Enumeration values:
HTTP_PROTOCOL_1_0  
HTTP_PROTOCOL_1_1  


Function Documentation

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.

template<typedef T>
const T& abs const T &   v [inline]
 

char* b64decode char *   source,
char *   dest = NULL
 

char* b64encode const char *   source,
char *   dest,
unsigned   size
 

bool canAccess const char *   path
 

bool canModify const char *   path
 

void ccxx_sleep timeout_t   msec
 

This is mapped into sleep().

Parameters:
msec   timeout in millisecond time range.

void ccxx_yield void  
 

This is mapped into yield().

void execHandler Thread *   th
 

int get Buffer &   b,
void *   o
[inline]
 

throw_t getException void  
 

Returns:
exception mode.

Thread* getThread void  
 

struct in_addr getaddress const InetAddress &   ia [inline]
 

struct timespec* gettimeout struct timespec *   spec,
timeout_t   timeout
 

bool isDevice const char *   path
 

bool isDir const char *   path
 

bool isFile const char *   path
 

objCounter   [inline]
 

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

template<class Key, class Value>
Engine& operator<< Engine &   ar,
std::map< Key, Value > const &   ob
throw ( Engine::Exception )
 

serialize a map with keys/values which both are serializeable to an engine.

template<class T>
Engine& operator<< Engine &   ar,
std::vector< T > const &   ob
throw ( Engine::Exception )
 

serialize a vector of some serializable content to the engine.

Engine& operator<< Engine &   ar,
bool   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
std::string   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
double   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
float   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
uint64   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
int64   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
uint32   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
int32   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
uint16   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
int16   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
uint8   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
int8   ob
throw ( Engine::Exception )
 

Engine& operator<< Engine &   ar,
BaseObject const *   ob
throw ( Engine::Exception )
 

template<class Key, class Value>
Engine& operator>> Engine &   ar,
std::map< Key, Value > &   ob
throw ( Engine::Exception )
 

deserialize a map with keys/values which both are serializeable from an engine.

template<class T>
Engine& operator>> Engine &   ar,
std::vector< T > &   ob
throw ( Engine::Exception )
 

deserialize a vector of deserializable content from an engine.

Engine& operator>> Engine &   ar,
bool &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
std::string &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
double &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
float &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
uint64 &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
int64 &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
uint32 &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
int32 &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
uint16 &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
int16 &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
uint8 &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
int8 &   ob
throw ( Engine::Exception )
 

Engine& operator>> Engine &   ar,
BaseObject *&   ob
throw ( Engine::Exception )
 

void pdetach void  
 

This function provides a simple and portable means to fork/detach a process into a daemon. This function provides a simple and portable means to fork/detach a process into a daemon.

Author:
David Sugar <dyfet@ostel.com>

int peek Buffer &   b,
void *   o
[inline]
 

int put Buffer &   b,
void *   o
[inline]
 

void setException throw_t   mode
 

Returns:
exception mode.

void sigHandler int   signo
 

char* urldecode char *   source,
char *   dest = NULL
 

char* urlencode const char *   source,
char *   dest,
unsigned   size
 

void wait signo_t   signo
 

virtual ~objCounter   [inline, virtual]
 


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.

struct ost::_fcb ost::fcb_t
 

struct ost::_keysym ost::keysym_t
 

struct ost::_keyval ost::keyval_t
 

class objCounter protected static unsigned ost::objCount
 

Slog ost::slog
 


Generated at Fri Jan 4 18:51:47 2002 for CommonC++ by doxygen1.2.10 written by Dimitri van Heesch, © 1997-2001