Bayonne Framework Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
ost::AppDataUnitInterface (envelope) to data received over RTP packets
ost::ApplicationHandlerApplication objects modification methods
ost::AssocThis class is used to associate (object) pointers with named strings.associate names with pointers
ost::AtomicCounterThe AtomicCounter class offers thread-safe manipulation of an integer counter.atomic counter operation
ost::AudioGeneric audio class to hold master data types and various useful class encapsulated friend functions as per GNU Common C++ 2 coding standard.Master audio class
ost::Audio::dtmf_detect_state_t
ost::Audio::goertzel_state_t
ost::Audio::InfoAudio source description
ost::Audio::mpeg_audio
ost::Audio::mpeg_tagv1
ost::Audio::tone_detection_descriptor_t
ost::AudioBaseAudioBase base class for many other audio classes which stream data.common audio stream base
ost::AudioBufferThe AudioBuffer class is for mixing one-to-one soft joins.audio buffer mixer class
ost::AudioCodecThe codec class is a virtual used for transcoding audio samples between linear frames (or other known format) and an encoded "sample" buffer.process codec interface
ost::AudioDevice
ost::AudioFileA class used to manipulate audio data.audio file access
ost::AudioStreamAudioStream accesses AudioFile base class content as fixed frames of streaming linear samples.Audio Streaming with Linear Conversion
ost::AudioToneThe AudioTone class is used to create a frame of audio encoded single or dualtones.audio tone generator class
ost::AVPQueueThis class, an RTP/RTCP queue, adds audio/video profile (AVP) specific methods to the generic RTCP service queue (QueueRTCPManager)
ost::BaseObjectBaseObjectBase class for classes that will be persistent
ost::BayonneGeneric Bayonne master class to reference various useful data types and core static members used for locating resources found in libbayonne.Master bayonne library class
ost::Bayonne::EventThe event data structure includes the event identifier and any paramaters
ost::Bayonne::libaudio_t
ost::Bayonne::regauth_t
ost::Bayonne::StateThe primary state data structure
ost::Bayonne::statetabA list of each state and a description
ost::BayonneAudioOffers core Bayonne audio processing in a self contained class.self contained Bayonne audio processing
ost::BayonneBinderAn intermediary binder class for Bayonne engine.Binder class
ost::BayonneConfigA bayonne config class, used for special purposes, especially during script compiles.Bayonne config cache for compiler
ost::BayonneDriverThe principle driver node for a given collection of spans and sessions of a given Bayonne driver family type.Bayonne driver node class
ost::BayonneMsgportBayonne Msgports are used to queue and post session events which normally have to be passed through another thread context.Msgport event queing and dispatch
ost::BayonneServiceBayonne services are used for threaded modules which may be installed at runtime.threaded server service
ost::BayonneSessionThe primary session object representing a server timeslot and active communication endpoint in Bayonne.Session timeslot object
ost::BayonneSpanA span is a collection of ports under a single control interface or communication channel, such as a T1/E1/PRI/BRI span.Span management object
ost::BayonneSysexecCore class for any server which impliments libexec functionality.Server system execution interface
ost::BayonneTranslatorA core class to support language translation services in Bayonne phrasebook.Phrasebook translation base class
ost::BayonneTSession
ost::BufferThe 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
ost::CancellationA class to automatically set the thread cancellation mode of a member function.Automatic cancellation mode setting
ost::ChecksumDigestA simple checksum digest function.checksum hash function
ost::cistring_char_traits< charT >
ost::CommandOptionCommandOption is the base class for all command line options
ost::CommandOptionArgClass for options with an argument e.g
ost::CommandOptionCollectIt 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
ost::CommandOptionNoArgCommandOption type for flags
ost::CommandOptionParseThis is the CommandOptionParse interface class
ost::CommandOptionRestIt 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
ost::CommandOptionWithArgDerived class of CommandOption for options that have a value associated with them
ost::ConditionalA conditional variable synchcronization object for one to one and one to many signal and control events between processes.conditional
ost::ConflictHandlerTo track addresses of sources conflicting with the local one
ost::ConflictHandler::ConflictingTransportAddress
ost::Counter< T >The counter template is used for generic objects which act as automatic counters.Automatic counter template class
ost::CRC16DigestA crc16 collection/compution hash accumulator class.crc16 computation hash
ost::CRC32DigestA crc32 collection/computation hash accumulator class.crc32 computation hash
ost::DateThe Date class uses a julian date representation of the current year, month, and day.julian number based date class
ost::DateNumberA number class that manipulates a string buffer that is also a date.a number that is also a date string
ost::DatetimeThe 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
ost::DestinationListHandlerThis class handles a list of destination addresses
ost::DestinationListHandler::TransportAddress
ost::DigestThe digest base class is used for implementing and deriving one way hashing functions.base class for hashing services
ost::DigestExceptionDigestExceptionExceptions involving digests
ost::DirA low level portable directory class.low level directory access class
ost::DirException
ost::DirTreeA generic class to walk a hierarchical directory structure.Directory tree walking
ost::DSOThe DSO dynamic loader class is used to load object files.Dynamic class file loader
ost::DSOException
ost::DTMFDetectDTMFDetect is used for detecting DTMF tones in a stream of audio
ost::DTMFTonesDTMFTones is used to generate a series of dtmf audio data from a "telephone" number passed as an ASCII string.Generate DTMF audio
ost::DualRTPChannel< BaseSocket >
ost::DualRTPChannelIPV6< BaseSocket >
DualUDPIPv4SocketA socket class based on two UDP/IPv4 sockets
DualUDPIPv6SocketA socket class based on two UDP/IPv6 sockets
ost::DynamicPayloadFormatDynamic payload format objects
ost::EngineEnginestream serialization of persistent classes
ost::EventThe Event class implements a feature originally found in the WIN32 API; event notification.Thread synchornization on event notification
ost::ExceptionMainline exception handler, this is the root for all Common C++ exceptions and assures the ansi C++ exception class hierarchy is both followed and imported into the gnu Common C++ class hierarchy.Base exception class for all Common C++ exceptions
ost::File
ost::File::_fcb
ost::FileException
ost::FixedBufferA buffer class that holds a known capacity of fixed sized objects defined during creation.producer/consumer buffer for fixed size objects
ost::IncomingDataQueueQueue for incoming RTP data packets in an RTP session
ost::IncomingDataQueue::SyncSourcesIteratorIterator through the list of synchronizations sources in this session
ost::IncomingDataQueueBase
ost::IncomingRTPPktRTP packets received from other participants
ost::InterruptException
ost::IOExceptionA sub-hierarchy for all Common C++ I/O related classes.I/O operation exception hierarchy
ost::IOZException
ost::IPV4AddressThe network name and address objects are all derived from a common IPV4Address base class.Internet Address binary data type
ost::IPV4BroadcastThe broadcast address object is used to store the broadcast address for a specific subnet
ost::IPV4HostThis 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
ost::IPV4MaskInternet 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
ost::IPV4MulticastA specialization of IPV4Address that provides address validation for multicast addresses.A multicast network address
ost::IPV4MulticastValidatorClass for the function object that validates multicast addresses.Validating class specialized for multicast addresses
ost::IPV4ValidatorClasses derived from IPV4Address would require an specific validator to pass to the IPV4Address constructor.Abstract base class for derived inet addresses validators
ost::IPV6AddressThe network name and address objects are all derived from a common IPV6Address base class.Internet Address binary data type
ost::IPV6BroadcastThe broadcast address object is used to store the broadcast address for a specific subnet
ost::IPV6HostThis 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
ost::IPV6MaskInternet 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
ost::IPV6MulticastA specialization of IPV6Address that provides address validation for multicast addresses.A multicast network address
ost::IPV6MulticastValidatorClass for the function object that validates multicast addresses.Validating class specialized for multicast addresses
ost::IPV6ValidatorClasses derived from IPV6Address would require an specific validator to pass to the IPV6Address constructor.Abstract base class for derived inet addresses validators
ost::IZStream
ost::KeydataKeydata objects are used to load and hold "configuration" data for a given application.load text configuration files into keyword pairs
ost::Keydata::Define
ost::Keydata::Keysym
ost::Keydata::Keyval
ost::keyMap< T, S >
ost::LibexecContainer class for applications implimenting the libexec process method of Bayonne interfacing.Libexec process interface class
ost::LockfileThis 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
ost::MappedFileCreate and map a disk file into memory.Map a named disk file into memory
ost::MD5DigestA md5 collection/computation accululator class.md5 hash accumulation
ost::MembersMembers and senders accounting
ost::MembershipBookkeepingControls the group membership in the current session
ost::MembershipBookkeeping::IncomingRTPPktLinkIncoming RTP data packets control structure within the incoming packet queue class
ost::MembershipBookkeeping::SyncSourceLinkSynchronization Source internal handler within the incoming packets queue
ost::MemPagerThe 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
ost::MemPagerObjectThis class is used to create derived classes which are constructed within a memory pager pool.create objects in a memory pager
ost::MFTonesMFTones is used to generate a series of mf audio data from a "telephone" number passed as an ASCII string.Generate MF audio
ost::MIMEFormDataThis is a document part type for use in submitting multipart form data to a web server.multipart document part for web form data field
ost::MIMEItemPartThis is used to attach an item part to a MIME multipart document that is being streamed.item or part of a multi-part object
ost::MIMEMultipartA container class for multi-part MIME document objects which can be streamed to a std::ostream destination.container for streamable multi-part MIME documents
ost::MIMEMultipartFormThe 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
ost::MutexThe 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
ost::MutexCounterThe Mutex Counter is a counter variable which can safely be incremented or decremented by multiple threads.Thread protected integer counter
ost::MutexLockThe 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
ost::NetworkDeviceInfoNetwork device information class
ost::NumberA number manipulation class.number manipulation
ost::objCounter< T >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
ost::objList< T, K >Used to create and manage a single linked list of objects of a common type.single linked list searchable template chain
ost::objMap< T, K, S >Used to create and manage a hash index of objects through a common type.hash indexed searchable template chain
ost::objSync< T >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
ost::OutgoingDataQueueA generic outgoing RTP data queue supporting multiple destinations
ost::OutgoingDataQueue::OutgoingRTPPktLink
ost::OutgoingDataQueueBase
ost::OutgoingRTPPktRTP packets being sent
ost::OZStream
ost::ParticipantA class of objects representing remote participants (RTP applications) in a multimedia session
ost::ParticipantHandlerParticipant objects modification methods
ost::PayloadFormatBase payload format class
ost::PersistException
ost::Pointer< T >Used to create and manage referece counted pointers.reference counted pointer template
ost::PosixThread
ost::ProcessA class for containing portable process related functions that help create portable code.Peocess wrapper class
ost::QueueRTCPManagerAdds generic management of RTCP functions to an RTP data queue
ost::RandomFileThe 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
ost::ReadLockThe 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
ost::RTCPCompoundHandlerLow level structs and RTCP packet parsing and building methods
ost::RTCPCompoundHandler::APPPacketStruct for APP (application specific) RTCP packets
ost::RTCPCompoundHandler::BYEPacketStruct for BYE (leaving session) RTCP packets
ost::RTCPCompoundHandler::FIRPacketStruct for Full Intra-frame Request (FIR) RTCP packet
ost::RTCPCompoundHandler::NACKPacketStruct for Negative ACKnowledgements (NACK) RTCP packet
ost::RTCPCompoundHandler::ReceiverInfoStruct for the data contained in a receiver info block
ost::RTCPCompoundHandler::RecvReportRaw structure of the source and every receiver report in an SR or RR RTCP packet
ost::RTCPCompoundHandler::RRBlockStruct for a receiver info block in a SR (sender report) or an RR (receiver report) RTCP packet
ost::RTCPCompoundHandler::RTCPFixedHeaderFixed RTCP packet header
ost::RTCPCompoundHandler::RTCPPacketStruct representing general RTCP packet headers as they are sent through the network
ost::RTCPCompoundHandler::SDESChunkStruct for a chunk of items in a SDES RTCP packet
ost::RTCPCompoundHandler::SDESItemStruct for an item description of a SDES packet
ost::RTCPCompoundHandler::SenderInfoStruct for the sender info block in a SR (sender report) RTCP packet
ost::RTCPCompoundHandler::SendReportStruct for SR (sender report) RTCP packets
ost::RTCPReceiverInfoReport block information of SR/RR RTCP reports
ost::RTCPSenderInfoSender block information of SR RTCP reports
ost::RTPApplicationAn RTP application, holding identifying RTCP SDES item values
ost::RTPApplication::ParticipantsIteratorIterator through the list of participants in this session
ost::RTPBaseUDPIPv4SocketA UDP/IPv4 socket class targetted at RTP stacks
ost::RTPBaseUDPIPv6Socket
ost::RTPDataQueueA packet queue handler for building different kinds of RTP protocol systems.RTP data queue handler
ost::RTPDuplexA peer associated RTP socket pair for physically connected peer hosts.RTP peer host over UDP
ost::RTPPacketA base class for both IncomingRTPPkt and OutgoingRTPPkt
ost::RTPPacket::RFC2833PayloadStructure defining RFC2833 Telephony events
ost::RTPQueueBaseA virtual base class for RTP queue hierarchies
RTPSessionBaseGeneric RTP protocol stack for exchange of realtime data.RTP protocol stack based on Common C++
ost::RTPSessionBaseHandler
RTPSessionBaseIPV6Generic RTP protocol stack for exchange of realtime data.RTP protocol stack based on Common C++
ost::RTPSessionPoolThis class is a base class for classes that define a group of RTP sessions that will be served by one or more execution threads
ost::RunableA container for objects that can be queued against a runlist.runable object with notify when ready
ost::RunlistA runlist is used to restrict concurrent exection to a limited set of concurrent sessions, much like a semaphore.list of runable objects
ost::ScriptGeneric script class to hold master data types and various useful class encpasulated friend functions.Master script class
ost::Script::_array
ost::Script::_symbol
ost::Script::Define
ost::Script::Fun
ost::Script::Initial
ost::Script::InitScript
ost::Script::Line
ost::Script::Name
ost::Script::NamedEvent
ost::Script::Package
ost::Script::Test
ost::ScriptBinder
ost::ScriptChecks
ost::ScriptCommandThis class holds the bound keyword set for a given Bayonne style script interpreter.Bayonne script keyword binding tables and compiler constants
ost::ScriptCompilerA derivable class to hold compiled script images for active processes.Script compiler image set
ost::ScriptCompiler::_merge
ost::ScriptImageA derivable class to hold compiled script images for active processes.Script compiler image set
ost::ScriptImage::InitialList
ost::ScriptInterp
ost::ScriptInterp::Frame
ost::ScriptMethods
ost::ScriptObjectA linkable list of objects that can be destroyed when a script image is removed from memory.Object list in image
ost::ScriptPropertyThis class is used for DSO modules that impliment property extensions for scripting objects.ccScript property module
ost::ScriptRegistryThis class is used for registering scripts with an external registry.Registry for script objects
ost::ScriptRipple
ost::ScriptRuntime
ost::ScriptSymbols
ost::ScriptThread
ost::SDESItemsHolderHolds the SDES items and related information from a participant in an RTP application
ost::SemaphoreA 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
ost::SemaphoreLockThe 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
ost::SerException
ost::SerialThe Serial class is used as the base for all serial I/O services under APE.base class for all serial I/O services
ost::SerialPortThe 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
ost::SerialServiceThe SerialService is a thead service object that is meant to service attached serial ports.Thread pool service for serial ports
ost::SHA1DigestSHA1DigestSHA-1 Digest Implementation
ost::SHA256DigestSHA256Digest SHA-256 Digest Implementation
ost::SHA64DigestHelperSHA64DigestHelperBase class for the 64-bit wide SHA*Digests
ost::SHAConstantSHAConstantContains SHA constants
ost::SHADigest< uint_type, blockSizeInBytes >SHADigestBase class for the SHA*Digests
ost::SharedFileThis 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
ost::SharedMemPagerThe shared mempager uses a mutex to protect key access methods.mutex protected memory pager
ost::SHATumbler< int_type >SHATumblerSHA Helper Class
ost::SimpleTCPStreamSimple TCP Stream, to be used with Common C++ Library
ost::SingleRTPSessionPool
ost::SingleThreadRTPSession< RTPDataChannel, RTCPChannel, ServiceQueue >This template class adds the threading aspect to the RTPSessionBase template in one of the many possible ways
ost::SingleThreadRTPSessionIPV6< RTPDataChannel, RTCPChannel, ServiceQueue >This template class adds the threading aspect to the RTPSessionBase template in one of the many possible ways
ost::SlogThe slog class is used to stream messages to the system's logging facility (syslogd).system logging facility class
ost::SocketThe Socket is used as the base for all Internet protocol services under Common C++.base class of all sockets
ost::SocketPortThe 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
ost::SocketServiceThe SocketService is a thread pool object that is meant to service attached socket ports.Thread pool service object for socket ports
ost::SockException
ost::SString
ost::StackPagerThe StackPager provides a repository to stash and retrieve working data in last-in-first-out order.last in first out object pager
ost::StaticPayloadFormatStatic payload format objects
ost::StringThis is a generic and portable string class.Generic string class
ost::StringObjectThe 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
ost::StringTokenizerSplits delimited string into tokens
ost::StringTokenizer::iteratorThe input forward iterator for tokens
ost::StringTokenizer::NoSuchElementExceptionException thrown, if someone tried to read beyond the end of the tokens
ost::SyncExceptionA sub-hierarchy for all task synchronizion related exceptions.Synchronization object exception hierarchy
ost::SyncSourceSynchronization source in an RTP session
ost::SyncSourceHandlerSyncSource objects modification methods
ost::SysTimeThis class is used to access non-reentrant date and time functions in the standard C library.Thread safe date and time functions
ost::TCPSessionThe 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
ost::TCPSocketTCP sockets are used for stream based connected sessions between two sockets.bound server for TCP streams and sessions
ost::TCPStreamTCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections.streamable TCP socket connection
ost::TCPV6SocketTCPV6 sockets are used for stream based connected sessions between two ipv6 sockets.bound server for TCP streams and sessions
ost::TelToneAn object that is used to sequence and extract telephony tones based on a telephony tone descriptor retrieved from the parsed international telephony tone database.telephony tone sequencing object
ost::TelTone::_tonedef
ost::TelTone::_tonekey
ost::ThreadEvery 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
ost::ThreadFileThis 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
ost::ThreadKeyThis 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
ost::ThreadLockThe 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
ost::ThreadQueueSomewhat generic queue processing class to establish a producer consumer queue.in memory data queue interface
ost::ThrExceptionA sub-hierarchy for thread exceptions.thread exception hierarchy
ost::TimeThe Time class uses a integer representation of the current time.Integer based time class
ost::TimerPortTimer ports are used to provide synchronized timing events when managed under a "service thread" such as SocketService.synchronized millisecond timing for service threads
ost::TRTPSessionBase< RTPDataChannel, RTCPChannel, ServiceQueue >
ost::TRTPSessionBaseIPV6< RTPDataChannel, RTCPChannel, ServiceQueue >
ost::TTYSessionThe 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
ost::TTYStreamTTY streams are used to represent serial connections that are fully "streamable" objects using C++ stream classes and friends.streamable tty serial I/O class
ost::ttystreamA more natural C++ "ttystream" class for use by non-threaded applications.C++ "fstream" style ttystream class
ost::TypeManagerThis class manages the types for generation of the persistent objects.Type manager for persistence engine
ost::TypeManager::RegistrationThis manages a registration to the typemanager - attempting to remove problems with the optimisers
ost::UDPBroadcastRepresenting a UDP socket used for subnet broadcasts, this class provides an alternate binding and setPeer() capability for UDP sockets.Unreliable Datagram for subnet broadcasts
ost::UDPDuplexUDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts.Unreliable Datagram Peer Associations
ost::UDPReceiveRepresenting half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet.Unreliable Datagram Peer Associations
ost::UDPSocketUDP sockets implement the TCP SOCK_DGRAM UDP protocol.Unreliable Datagram Protocol sockets
ost::UDPTransmitRepresenting 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
ost::UnixSessionThe 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
ost::UnixSocketUnix domain sockets are used for stream based connected sessions between processes on the same machine.bound server for Unix domain streams and sessions
ost::unixstreamA more natural C++ "unixstream" class for use by non-threaded applications.C++ "fstream" style unixstream class
ost::UnixStreamUnix streams are used to represent Unix domain client connections to a local server for accepting client connections.streamable Unix domain socket connection
ost::URLStreamA URL processing version of TCPStream.C++ url processing stream class
ost::WriteLockThe 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
ost::XMLRPCThis class impliments a core XMLRPC service without the underlying transports.XML-RPC service building class
ost::XMLStreamThis 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)
ost::ZNumber

Generated on Thu Apr 6 09:03:03 2006 for Bayonne Framework by  doxygen 1.4.6