S3FC project page S3FC home page

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

Stone Three Foundation Classes Compound List

Here are the classes, structs, unions and interfaces with brief descriptions:
s3_conditionA condition variable that is implemented as a wrapper around the pthread_cond_t
s3_config_baseA configuration object creates a tree of s3_config_node
s3_config_nodeThis provides an abstraction of a configuration node
s3_conversionCurrently we can convert 'to string' or 'from string'
s3_conversion::exceptionIndicates that an exception occured during a conversion
s3_event_dispatcher< T_Event >Templated base class that contains a list of event handlers
s3_event_handler< T_Event >Templated ABC that handles an event
s3_exceptionAll exceptions are derived from this class, inherited from std::exception
s3_fifo_base< T >Abstract Base Class (ABC) used to derive FIFO queue classes
s3_fifo_queue< T >FIFO (First-In First-Out) queue that owns its contents and allows consumers and producers to mutate and inspect data in-place
s3_file_bufferThe streambuffer used to log messages to a text file
s3_fileloggerThis class is used to stream messages to a text file
s3_generic_exceptionGeneric exception - this can be used for anything, but it is advised that more specific exception rather be created
s3_generic_streambufA generic buffered stream buffer
s3_growable_fifo_queue< T >Thread safe multi-consumer/multi-producer FIFO queue template
s3_index_exceptionIndex bounds violation - use this if an index value is outside of the range [min,max]
s3_inplace_fifo_base< T >Abstract Base Class (ABC) used to derive FIFO queue classes allowing inplace operation
s3_inplace_fifo_base< s3_txport_data< s3_message >>
s3_inplace_fifo_base< s3_txport_data< T_Data >>
s3_inplace_fifo_mux< T >Inplace FIFO queue multiplexer/demultiplexer: Multiplex or demultiplexa single s3_inplace_fifo_base<T> into a number of virtual queues, which are also s3_inplace_fifo_base<T> 's
s3_inplace_fifo_mux< T >::stub_queueStub class representing a virtual queue associated with a single s3_inplace_fifo_mux instance
s3_log_bufferThe streambuffer used to log messages to a number of registered ostream objects
s3_loggerThis class is used to stream messages to a number of registered ostreams
s3_messageAn implementation of a Message
s3_message_boxAn implementation of a Message box
s3_msgb_log_bufferThe streambuffer used to log messages to an S3 message box
s3_msgb_log_rx_threadThis thread could (and should) be used in conjunction with ostream derived class s3_msgb_logger
s3_msgb_loggerThis class is used to stream messages to an S3 message box
s3_mutexA mutex (MUTual EXclusion primitive) that is implemented as a wrapper around pthread_mutex_t
s3_pack_bufferAn s3_pack_buffer one or more packed objects
s3_periodic_notifierInstantiate one of these to periodically signal an event using a semaphore
s3_periodic_notifier::event_loopHelper class that implements the timing loop for all s3_periodic_notifier s in a process space (clients)
s3_post_officeA Post Office implementation
s3_post_office::client_msgA message and its originating client
s3_post_office::dst_dataData associated with each destination: list of sucscribed client instances and group flag
s3_post_office_switchAn implementation of Post Office Switch
s3_post_office_switch::dst_dataData associated with each destination: client list and group flag
s3_post_office_switch::txp_event_queuerTCP transport event handler
s3_ring_buffer< T >This class implements a ring (or circular) buffer
s3_rpc_caller_m< T_obj >Abstract Base Class representing a caller that invokes a member function (method) of an object of type T_obj
s3_rpc_caller_m_v_t1< T_obj, T_arg1 >s3_rpc_caller_m that invokes a non-const method returning void and taking one argument, i.e
s3_rpc_caller_m_v_t2< T_obj, T_arg1, T_arg2 >s3_rpc_caller_m that invokes a non-const method returning void and taking two arguments, i.e
s3_rpc_caller_m_v_v< T_obj >s3_rpc_caller_m that invokes a non-const method returning void and taking no arguments, i.e
s3_rpc_client< T_obj >
s3_rpc_commonType unspecific common types, functions and constants
s3_rpc_exceptionException thrown when any of the s3_rpc_caller_m methods fail
s3_rpc_server< T_obj >An RPC server that controls a single T_obj instance
s3_rpc_type_common< T_obj >Type specific common types, functions and constants
s3_semaphoreA semaphore that is implemented as a wrapper around POSIX 1003.1b sem_t (implemented in LinuxThreads)
s3_smanip< TP >
s3_socket_tcp
s3_socket_tcp_ssl
s3_spsc_fifo_queue< T >This is a single producer, single consumer (SPSC), first in, first out (FIFO) queue
s3_streamable
s3_streamable_dispatcher< T >
s3_streamable_helper_other< std::string >s3_streamable_helper_other specialisation for string
s3_streamable_helper_pod< T >Note: Never call any function in this class directly - these should only be called from s3_streamable_dispatcher<T, s3_typegroup_pod>
s3_streamable_helper_stl< T >This is the helper class that is invoked to pack types in the s3_typegroup_stl_seq
s3_streamable_helper_streamable< T >Note: Never call any function in this class directly - these should only be called from s3_streamable_dispatcher<T, s3_typegroup_streamable>
s3_subscribable_fifoA helper class that implements the consumer and producer subscription and notification
s3_syslog_bufferThe streambuffer used to log messages to syslog
s3_sysloggerThe class used to stream messages to syslog
s3_thread_baseAbstract Base Class (ABC) used to create a class with a single main event loop, that is executed in its own thread
s3_txport_base< T_Data >Abstract base class for a generic transport mechanism
s3_txport_data< T_Data >Data class used by the s3_txport system
s3_txport_eventEvent type for the s3_txport system
s3_txport_local< T_Data >Local (inter-thread) transport mechanism
s3_txport_tcp< T_Data, T_Socket >Bidirectional homogeneous TCP transport mechanism
s3_txport_tcp< T_Data, T_Socket >::metadata_typePrivate structure to communicate metadata to the system
s3_txport_tcp_rx_task< T_Data, T_Socket >Private server receive thread
s3_txport_tcp_tx_task< T_Data, T_Socket >TCP send thread, used internally by the server class
s3_typegroup_otherTag class denoting a class that does not fall into any of th other categories
s3_typegroup_podTag class denoting a POD (Plain Old Data) struct
s3_typegroup_stlTag class denoting a class that is an STL Sequence or an STL Unique Sorted Associative Container
s3_typegroup_streamableTag class denoting a class derived from s3_streamable
s3_typegroup_traits< T >Alternative traits class that maps a type to a typegroup: this is used with that does not support partial template specialisations
s3_utilsSome utility functions
s3_xml_configCreate a tree of s3_config_node s from an XML file
s3_xml_config::error_handlerError handler that reports all warnings, errors and fatal errors by throwing an s3_xml_exception
s3_xml_exceptionException indicating an XML parse error

Send comments to: s3fc@stonethree.com SourceForge Logo