📦 libcommoncpp2-doc

182 pages

A

  • address.h(3)Network addresses and sockets related classes.✨
  • applog.h(3)Application logging facilities abstraction.✨

B

  • buffer.h(3)object passing services between threads.✨

C

D

  • digest.h(3)Digest algorithms: checksum, CRC and MD5.✨

E

F

M

  • mime.h(3)MIME document abstractions.✨
  • misc.h(3)Memory management, configuration keydata objects and string tokenizer.✨
  • missing.h(3)substitute functions which may be missing in target platform libc.✨

N

O

  • objcount.h(3)Template for object which holds self count of instances.✨
  • object.h(3)Some object manipulation classes for smart pointers, linked lists, etc.✨
  • objlink.h(3)Template for creating linked list of objects with lookup.✨
  • objmap.h(3)Template for creating hash indexed objects.✨
  • objsync.h(3)Template for creating objects that share a global mutex.✨
  • ost(3)✨
  • ost_AppLog(3)Application logger is a class that implements a logger that can be used by applications to save log file somewhere on the system.✨
  • ost_AppLog_Ident(3)Ident class that represents module name.✨
  • ost_Assoc(3)This class is used to associate (object) pointers with named strings.✨
  • ost_AtomicCounter(3)The AtomicCounter class offers thread-safe manipulation of an integer counter.✨
  • ost_BaseObject(3)BaseObject.✨
  • ost_Buffer(3)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.✨
  • ost_Cancellation(3)A class to automatically set the thread cancellation mode of a member function.✨
  • ost_ChecksumDigest(3)A simple checksum digest function.✨
  • ost_cistring_char_traits(3)✨
  • ost_CommandOption(3)CommandOption is the base class for all command line options.✨
  • ost_CommandOptionArg(3)Class for options with an argument e.g.✨
  • ost_CommandOptionCollect(3)It only makes sense to have a single one of these set and it is also exclusive with CommandOptionRest.✨
  • ost_CommandOptionNoArg(3)CommandOption type for flags.✨
  • ost_CommandOptionParse(3)This is the CommandOptionParse interface class.✨
  • ost_CommandOptionRest(3)It only makes sense to have a single one of these set and it is exclusive with CommandOptionCollect.✨
  • ost_CommandOptionWithArg(3)Derived class of CommandOption for options that have a value associated with them.✨
  • ost_Conditional(3)A conditional variable synchcronization object for one to one and one to many signal and control events between processes.✨
  • ost_Counter(3)The counter template is used for generic objects which act as automatic counters.✨
  • ost_CRC16Digest(3)A crc16 collection/compution hash accumulator class.✨
  • ost_CRC32Digest(3)A crc32 collection/computation hash accumulator class.✨
  • ost_Date(3)The Date class uses a julian date representation of the current year, month, and day.✨
  • ost_DateNumber(3)A number class that manipulates a string buffer that is also a date.✨
  • ost_Datetime(3)The Datetime class uses a julian date representation of the current year, month, and day and a integer representation of the current time.✨
  • ost_DCCPSocket(3)DCCP sockets are used for stream based connected sessions between two sockets.✨
  • ost_Digest(3)The digest base class is used for implementing and deriving one way hashing functions.✨
  • ost_Dir(3)A low level portable directory class.✨
  • ost_DirTree(3)A generic class to walk a hierarchical directory structure.✨
  • ost_DSO(3)The DSO dynamic loader class is used to load object files.✨
  • ost_Engine(3)Engine.✨
  • ost_Event(3)The Event class implements a feature originally found in the WIN32 API; event notification.✨
  • ost_File(3)✨
  • ost_File__fcb(3)✨
  • ost_FixedBuffer(3)A buffer class that holds a known capacity of fixed sized objects defined during creation.✨
  • ost_HEXdump(3)Produces a dump of a buffer in a hexdump way with its code Ascii translation and relative buffer address.✨
  • ost_IPV4Address(3)The network name and address objects are all derived from a common IPV4Address base class.✨
  • ost_IPV4Broadcast(3)The broadcast address object is used to store the broadcast address for a specific subnet.✨
  • ost_IPV4Cidr(3)The CIDR class is used to support routing tables and validate address policies.✨
  • ost_IPV4Host(3)This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket.✨
  • ost_IPV4Mask(3)Internet addresses used specifically as masking addresses (such as ' 255.255.255.0') are held in the IPV4Mask derived object.✨
  • ost_IPV4Multicast(3)A specialization of IPV4Address that provides address validation for multicast addresses.✨
  • ost_IPV4MulticastValidator(3)Class for the function object that validates multicast addresses.✨
  • ost_IPV4Validator(3)Classes derived from IPV4Address would require an specific validator to pass to the IPV4Address constructor.✨
  • ost_IPV6Address(3)The network name and address objects are all derived from a common IPV6Address base class.✨
  • ost_IPV6Broadcast(3)The broadcast address object is used to store the broadcast address for a specific subnet.✨
  • ost_IPV6Cidr(3)The CIDR class is used to support routing tables and validate address policies.✨
  • ost_IPV6Host(3)This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket.✨
  • ost_IPV6Mask(3)Internet addresses used specifically as masking addresses (such as ' 255.255.255.0') are held in the IPV6Mask derived object.✨
  • ost_IPV6Multicast(3)A specialization of IPV6Address that provides address validation for multicast addresses.✨
  • ost_IPV6MulticastValidator(3)Class for the function object that validates multicast addresses.✨
  • ost_IPV6Validator(3)Classes derived from IPV6Address would require an specific validator to pass to the IPV6Address constructor.✨
  • ost_IZStream(3)✨
  • ost_Keydata(3)Keydata objects are used to load and hold 'configuration' data for a given application.✨
  • ost_Keydata_Define(3)✨
  • ost_Keydata_Keysym(3)✨
  • ost_Keydata_Keyval(3)✨
  • ost_keyMap(3)✨
  • ost_LinkedDouble(3)Self managed double linked list object chain.✨
  • ost_LinkedSingle(3)Self managed single linked list object chain.✨
  • ost_Lockfile(3)This class is used to create a 'named' lock entity that can be used to control access to a resource between multiple processes.✨
  • ost_MapIndex(3)The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key.✨
  • ost_MapObject(3)The MapObject is a base class which can be used to make a derived class operate on a MapTable.✨
  • ost_MappedFile(3)Create and map a disk file into memory.✨
  • ost_MapTable(3)A map table allows for entities to be mapped (hash index) onto it.✨
  • ost_MD5Digest(3)A md5 collection/computation accululator class.✨
  • ost_MemPager(3)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.✨
  • ost_MemPagerObject(3)This class is used to create derived classes which are constructed within a memory pager pool.✨
  • ost_MIMEFormData(3)This is a document part type for use in submitting multipart form data to a web server.✨
  • ost_MIMEItemPart(3)This is used to attach an item part to a MIME multipart document that is being streamed.✨
  • ost_MIMEMultipart(3)A container class for multi-part MIME document objects which can be streamed to a std::ostream destination.✨
  • ost_MIMEMultipartForm(3)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.✨
  • ost_Mutex(3)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.✨
  • ost_MutexCounter(3)The Mutex Counter is a counter variable which can safely be incremented or decremented by multiple threads.✨
  • ost_MutexLock(3)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.✨
  • ost_NetworkDeviceInfo(3)Network device information class.✨
  • ost_Number(3)A number manipulation class.✨
  • ost_objCounter(3)Generic template class for creating classes which maintain an active count of the number of instances currently in active use.✨
  • ost_objList(3)Used to create and manage a single linked list of objects of a common type.✨
  • ost_objMap(3)Used to create and manage a hash index of objects through a common type.✨
  • ost_objSync(3)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.✨
  • ost_OZStream(3)✨
  • ost_Pointer(3)Used to create and manage referece counted pointers.✨
  • ost_PosixThread(3)✨
  • ost_Process(3)A class for containing portable process related functions that help create portable code.✨
  • ost_RandomFile(3)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.✨
  • ost_ReadLock(3)The ReadLock class is used to protect a section of code through a ThreadLock for 'read' access to the member function.✨
  • ost_RefObject(3)A reference countable object.✨
  • ost_RefPointer(3)Pointer to reference counted objects.✨
  • ost_Runable(3)A container for objects that can be queued against a runlist.✨
  • ost_Runlist(3)A runlist is used to restrict concurrent exection to a limited set of concurrent sessions, much like a semaphore.✨
  • ost_Semaphore(3)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.✨
  • ost_SemaphoreLock(3)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.✨
  • ost_Serial(3)The Serial class is used as the base for all serial I/O services under APE.✨
  • ost_SerialPort(3)The serial port is an internal class which is attached to and then serviced by a specified SerialService thread.✨
  • ost_SerialService(3)The SerialService is a thead service object that is meant to service attached serial ports.✨
  • ost_SharedFile(3)This class defines a database I/O file service that can be shared by multiple processes.✨
  • ost_SharedMemPager(3)The shared mempager uses a mutex to protect key access methods.✨
  • ost_SimpleTCPStream(3)Simple TCP Stream, to be used with Common C++ Library.✨
  • ost_Slog(3)The slog class is used to stream messages to the system's logging facility (syslogd).✨
  • ost_Socket(3)The Socket is used as the base for all Internet protocol services under Common C++.✨
  • ost_SocketPort(3)The socket port is an internal class which is attached to and then serviced by a specific SocketService 'object'.✨
  • ost_SocketService(3)The SocketService is a thread pool object that is meant to service attached socket ports.✨
  • ost_SSLStream(3)✨
  • ost_SString(3)✨
  • ost_StackPager(3)The StackPager provides a repository to stash and retrieve working data in last-in-first-out order.✨
  • ost_String(3)This is a generic and portable string class.✨
  • ost_StringObject(3)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.✨
  • ost_StringTokenizer(3)Splits delimited string into tokens.✨
  • ost_StringTokenizer_iterator(3)The input forward iterator for tokens.✨
  • ost_StringTokenizer_NoSuchElementException(3)Exception thrown, if someone tried to read beyond the end of the tokens.✨
  • ost_SysTime(3)This class is used to access non-reentrant date and time functions in the standard C library.✨
  • ost_TCPSession(3)The TCP session is used to primarily to represent a client connection that can be managed on a separate thread.✨
  • ost_TCPSocket(3)TCP sockets are used for stream based connected sessions between two sockets.✨
  • ost_TCPStream(3)TCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections.✨
  • ost_TCPV6Socket(3)TCPV6 sockets are used for stream based connected sessions between two ipv6 sockets.✨
  • ost_Thread(3)Every thread of execution in an application is created by instantiating an object of a class derived from the Thread class.✨
  • ost_ThreadFile(3)This class defines a database I/O file service that can be shared by multiple threads.✨
  • ost_ThreadKey(3)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.✨
  • ost_ThreadLock(3)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.✨
  • ost_ThreadQueue(3)Somewhat generic queue processing class to establish a producer consumer queue.✨
  • ost_ThreadQueue__data(3)✨
  • ost_Time(3)The Time class uses a integer representation of the current time.✨
  • ost_TimerPort(3)Timer ports are used to provide synchronized timing events when managed under a 'service thread' such as SocketService.✨
  • ost_TTYSession(3)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.✨
  • ost_TTYStream(3)TTY streams are used to represent serial connections that are fully 'streamable' objects using C++ stream classes and friends.✨
  • ost_ttystream(3)A more natural C++ 'ttystream' class for use by non- threaded applications.✨
  • ost_TypeManager(3)This class manages the types for generation of the persistent objects.✨
  • ost_TypeManager_Registration(3)This manages a registration to the typemanager - attempting to remove problems with the optimisers.✨
  • ost_UDPBroadcast(3)Representing a UDP socket used for subnet broadcasts, this class provides an alternate binding and setPeer() capability for UDP sockets.✨
  • ost_UDPDuplex(3)UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts.✨
  • ost_UDPReceive(3)Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet.✨
  • ost_UDPSocket(3)UDP sockets implement the TCP SOCK_DGRAM UDP protocol.✨
  • ost_UDPTransmit(3)Representing half of a two-way UDP connection, the UDP transmitter can broadcast data to another selected peer host or to an entire subnet.✨
  • ost_UnixSession(3)The Unix domain session is used to primarily to represent a client connection that can be managed on a separate thread.✨
  • ost_UnixSocket(3)Unix domain sockets are used for stream based connected sessions between processes on the same machine.✨
  • ost_UnixStream(3)Unix streams are used to represent Unix domain client connections to a local server for accepting client connections.✨
  • ost_unixstream(3)A more natural C++ 'unixstream' class for use by non- threaded applications.✨
  • ost_URLStream(3)A URL processing version of TCPStream.✨
  • ost_WriteLock(3)The WriteLock class is used to protect a section of code through a ThreadLock for 'write' access to the member function.✨
  • ost_XMLRPC(3)This class impliments a core XMLRPC service without the underlying transports.✨
  • ost_XMLStream(3)This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods.✨
  • ost_ZNumber(3)✨
  • oststring.h(3)✨

P

S

T

U

  • unix.h(3)UNIX domain sockets, streams and sessions.✨
  • url.h(3)URL streams abstraction.✨

X

  • xml.h(3)XML streams abstraction and RPC services.✨

Z