Bayonne2 / Common C++ 2 Framework
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Data Structures
Here are the data structures with brief descriptions:
[detail level 123]
oNGnuZrtpCodesThis enum defines the information message severity
|oCAudioGeneric audio class to hold master data types and various useful class encapsulated friend functions as per GNU Common C++ 2 coding standard
||oCInfoAudio source description
|oCAudioResampleUsed to manage linear intropolation buffering for rate conversions
|oCAudioToneUsed to create a frame of audio encoded single or dualtones
|oCAudioBaseAudioBase base class for many other audio classes which stream data
|oCAudioBufferFor mixing one-to-one soft joins
|oCAudioFileA class used to manipulate audio data
|oCAudioStreamAudioStream accesses AudioFile base class content as fixed frames of streaming linear samples
|oCAudioCodecThe codec class is a virtual used for transcoding audio samples between linear frames (or other known format) and an encoded "sample" buffer
|oCTelToneAn object that is used to sequence and extract telephony tones based on a telephony tone descriptor retrieved from the parsed international telephony tone database
|oCDTMFTonesDTMFTones is used to generate a series of dtmf audio data from a "telephone" number passed as an ASCII string
|oCMFTonesMFTones is used to generate a series of mf audio data from a "telephone" number passed as an ASCII string
|oCDTMFDetectDTMFDetect is used for detecting DTMF tones in a stream of audio
|oCStreamingBufferStreaming buffer for audio, to be used in bgm audio sources
|oCStaticKeydataBayonnne specific static keydata class
|oCDynamicKeydataBayonne specific dynamic keydata class
|oCReconfigKeydataBayonne specific reloaded keydata class
|oCBayonneGeneric Bayonne master class to reference various useful data types and core static members used for locating resources found in libbayonne
||oCEventThe event data structure includes the event identifier and any paramaters
||oCRingThis is an internal ring class for synchronized ringing
||oCRPCDefineThis is a structure used to initialize XMLRPC method tables
||oCRPCNodeThis is a little class used to associate XMLRPC call method tables with our server
||oCStateThe primary state data structure
||oCstatetabA list of each state and a description
||\CTrafficThis is a class used for collecting statistics for call traffic measurement, such as might be used by MRTG
|oCBayonneZeroconfThis class is used to bind services that are to be published with zeroconf, such as by the avahi module
|oCBayonneConfigA bayonne config class, used for special purposes, especially during script compiles
|oCBayonneTranslatorA core class to support language translation services in Bayonne phrasebook
|oCBayonneAudioOffers core Bayonne audio processing in a self contained class
|oCBayonneMsgportBayonne Msgports are used to queue and post session events which normally have to be passed through another thread context
|oCBayonneDriverThe principle driver node for a given collection of spans and sessions of a given Bayonne driver family type
|oCBayonneSpanA span is a collection of ports under a single control interface or communication channel, such as a T1/E1/PRI/BRI span
|oCBayonneBinderAn intermediary binder class for Bayonne engine
|oCBayonneSessionThe primary session object representing a server timeslot and active communication endpoint in Bayonne
|oCBayonneRPCBayonne RPC arguments, may be passed through to binders from webservice sessions for extensions to soap & xmlrpc services
|oCBayonneServiceBayonne services are used for threaded modules which may be installed at runtime
|oCScriptEngineOffers interface bridge for embedded scripting engines through an abstract interface
|oCLibexecContainer class for applications implimenting the libexec process method of Bayonne interfacing
|oCBayonneSysexecCore class for any server which impliments libexec functionality
|oCScriptGeneric script class to hold master data types and various useful class encpasulated friend functions
|oCScriptCommandThis class holds the bound keyword set for a given Bayonne style script interpreter
|oCScriptObjectA linkable list of objects that can be destroyed when a script image is removed from memory
|oCScriptImageA derivable class to hold compiled script images for active processes
|oCScriptCompilerA derivable class to hold compiled script images for active processes
|oCScriptRegistryThis class is used for registering scripts with an external registry
|\CScriptPropertyThis class is used for DSO modules that impliment property extensions for scripting objects
oCAlgorithmEnumThe algorithm enumration class
oCAppDataUnitInterface (envelope) to data received over RTP packets
oCApplicationHandlerApplication objects modification methods
oCAppLogApplication logger is a class that implements a logger that can be used by applications to save log file somewhere on the system
|\CIdentIdent class that represents module name
oCAssocThis class is used to associate (object) pointers with named strings
oCAtomicCounterOffers thread-safe manipulation of an integer counter
oCAVPQueueThis class, an RTP/RTCP queue, adds audio/video profile (AVP) specific methods to the generic RTCP service queue (QueueRTCPManager)
oCBufferThe 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
oCc_srtpSecretsThis structure contains pointers to the SRTP secrets and the role info
oCCancellationA class to automatically set the thread cancellation mode of a member function
oCChecksumDigestA simple checksum digest function
oCCommandOptionCommandOption is the base class for all command line options
oCCommandOptionArgClass for options with an argument e.g
oCCommandOptionCollectIt only makes sense to have a single one of these set and it is also exclusive with CommandOptionRest
oCCommandOptionNoArgCommandOption type for flags
oCCommandOptionParseThis is the CommandOptionParse interface class
oCCommandOptionRestIt only makes sense to have a single one of these set and it is exclusive with CommandOptionCollect
oCCommandOptionWithArgDerived class of CommandOption for options that have a value associated with them
oCConditionalA conditional variable synchcronization object for one to one and one to many signal and control events between processes
oCConflictHandlerTo track addresses of sources conflicting with the local one
oCCounterThe counter template is used for generic objects which act as automatic counters
oCCRC16DigestA crc16 collection/compution hash accumulator class
oCCRC32DigestA crc32 collection/computation hash accumulator class
oCCryptoContextThe implementation for a SRTP cryptographic context
oCCryptoContextCtrlThe implementation for a SRTCP cryptographic context
oCDateUses a julian date representation of the current year, month, and day
oCDateNumberA number class that manipulates a string buffer that is also a date
oCDatetimeUses a julian date representation of the current year, month, and day and a integer representation of the current time
oCDCCPSocketDCCP sockets are used for stream based connected sessions between two sockets
oCDestinationListHandlerThis class handles a list of destination addresses
oCDigestThe digest base class is used for implementing and deriving one way hashing functions
oCDirA low level portable directory class
oCDirTreeA generic class to walk a hierarchical directory structure
oCDSOThe DSO dynamic loader class is used to load object files
oCDualUDPIPv4SocketA socket class based on two UDP/IPv4 sockets
oCDynamicPayloadFormatDynamic payload format objects
oCEnumBaseEnumBase provides methods to store and access algorithm enumerations of a specific algorithm type
oCEventImplements a feature originally found in the WIN32 API; event notification
oCFixedBufferA buffer class that holds a known capacity of fixed sized objects defined during creation
oCHashEnumThe enumaration subclasses that contain the supported algorithm enumerations
oCHEXdumpProduces a dump of a buffer in a hexdump way with its code Ascii translation and relative buffer address
oCIncomingDataQueueQueue for incoming RTP data packets in an RTP session
|\CSyncSourcesIteratorIterator through the list of synchronizations sources in this session
oCIncomingRTPPktRTP packets received from other participants
oCIPV4AddressThe network name and address objects are all derived from a common IPV4Address base class
oCIPV4BroadcastThe broadcast address object is used to store the broadcast address for a specific subnet
oCIPV4CidrThe CIDR class is used to support routing tables and validate address policies
oCIPV4HostThis object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket
oCIPV4MaskInternet addresses used specifically as masking addresses (such as "") are held in the IPV4Mask derived object
oCIPV4MulticastA specialization of IPV4Address that provides address validation for multicast addresses
oCIPV4MulticastValidatorClass for the function object that validates multicast addresses
oCIPV4ValidatorClasses derived from IPV4Address would require an specific validator to pass to the IPV4Address constructor
oCKeydataKeydata objects are used to load and hold "configuration" data for a given application
oCLinkedDoubleSelf managed double linked list object chain
oCLinkedSingleSelf managed single linked list object chain
oCLockfileThis class is used to create a "named" lock entity that can be used to control access to a resource between multiple processes
oCMapIndexThe MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key
oCMapObjectThe MapObject is a base class which can be used to make a derived class operate on a MapTable
oCMappedFileCreate and map a disk file into memory
oCMapTableA map table allows for entities to be mapped (hash index) onto it
oCMD5DigestA md5 collection/computation accululator class
oCMembersMembers and senders accounting
oCMembershipBookkeepingControls the group membership in the current session
|oCIncomingRTPPktLinkIncoming RTP data packets control structure within the incoming packet queue class
|\CSyncSourceLinkSynchronization Source internal handler within the incoming packets queue
oCMemPagerThe 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
oCMemPagerObjectThis class is used to create derived classes which are constructed within a memory pager pool
oCMIMEFormDataThis is a document part type for use in submitting multipart form data to a web server
oCMIMEItemPartThis is used to attach an item part to a MIME multipart document that is being streamed
oCMIMEMultipartA container class for multi-part MIME document objects which can be streamed to a std::ostream destination
oCMIMEMultipartFormThe Multipart form is a MIME multipart document specific for the construction and delivery of form data to a web server through a post method
oCMutexUsed to protect a section of code so that at any given time only a single thread can perform the protected operation
oCMutexCounterThe Mutex Counter is a counter variable which can safely be incremented or decremented by multiple threads
oCMutexLockUsed to protect a section of code so that at any given time only a single thread can perform the protected operation
oCNetworkDeviceInfoNetwork device information class
oCNumberA number manipulation class
oCobjCounterGeneric template class for creating classes which maintain an active count of the number of instances currently in active use
oCobjListUsed to create and manage a single linked list of objects of a common type
oCobjMapUsed to create and manage a hash index of objects through a common type
oCobjSyncGeneric 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
oCOutgoingDataQueueA generic outgoing RTP data queue supporting multiple destinations
oCOutgoingRTPPktRTP packets being sent
oCParticipantA class of objects representing remote participants (RTP applications) in a multimedia session
oCParticipantHandlerParticipant objects modification methods
oCPayloadFormatBase payload format class
oCPointerUsed to create and manage referece counted pointers
oCPredEqualsStd equality for SessionListElement objects
oCProcessA class for containing portable process related functions that help create portable code
oCQueueRTCPManagerAdds generic management of RTCP functions to an RTP data queue
oCRandomFileThe purpose of this class is to define a base class for low level random file access that is portable between Win32 and Posix systems
oCReadLockUsed to protect a section of code through a ThreadLock for "read" access to the member function
oCRefObjectA reference countable object
oCRefPointerPointer to reference counted objects
oCRTCPCompoundHandlerLow level structs and RTCP packet parsing and building methods
|oCAPPPacketStruct for APP (application specific) RTCP packets
|oCBYEPacketStruct for BYE (leaving session) RTCP packets
|oCFIRPacketStruct for Full Intra-frame Request (FIR) RTCP packet
|oCNACKPacketStruct for Negative ACKnowledgements (NACK) RTCP packet
|oCReceiverInfoStruct for the data contained in a receiver info block
|oCRecvReportRaw structure of the source and every receiver report in an SR or RR RTCP packet
|oCRRBlockStruct for a receiver info block in a SR (sender report) or an RR (receiver report) RTCP packet
|oCRTCPFixedHeaderFixed RTCP packet header
|oCRTCPPacketStruct representing general RTCP packet headers as they are sent through the network
|oCSDESChunkStruct for a chunk of items in a SDES RTCP packet
|oCSDESItemStruct for an item description of a SDES packet
|oCSenderInfoStruct for the sender info block in a SR (sender report) RTCP packet
|\CSendReportStruct for SR (sender report) RTCP packets
oCRTCPReceiverInfoReport block information of SR/RR RTCP reports
oCRTCPSenderInfoSender block information of SR RTCP reports
oCRTPApplicationAn RTP application, holding identifying RTCP SDES item values
|\CParticipantsIteratorIterator through the list of participants in this session
oCRTPBaseUDPIPv4SocketA UDP/IPv4 socket class targetted at RTP stacks
oCRTPDataQueueA packet queue handler for building different kinds of RTP protocol systems
oCRTPDuplexA peer associated RTP socket pair for physically connected peer hosts
oCRTPPacketA base class for both IncomingRTPPkt and OutgoingRTPPkt
|oCRFC2833PayloadStructure defining RFC2833 Telephony events
|oCRTPFixedHeaderRTP fixed header as it is send through the network
|\CRTPHeaderExtFixed component of the variable-length header extension, appended to the fixed header, after the CSRC list, when X == 1
oCRTPQueueBaseA virtual base class for RTP queue hierarchies
oCRTPSessionBaseGeneric RTP protocol stack for exchange of realtime data
oCRTPSessionPoolThis class is a base class for classes that define a group of RTP sessions that will be served by one or more execution threads
oCRunableA container for objects that can be queued against a runlist
oCRunlistA runlist is used to restrict concurrent exection to a limited set of concurrent sessions, much like a semaphore
oCSDESItemsHolderHolds the SDES items and related information from a participant in an RTP application
oCSemaphoreA 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
oCSemaphoreLockUsed to protect a section of code through a semaphore so that only x instances of the member function may execute concurrently
oCSerialUsed as the base for all serial I/O services under APE
oCSerialPortThe serial port is an internal class which is attached to and then serviced by a specified SerialService thread
oCSerialServiceThe SerialService is a thead service object that is meant to service attached serial ports
oCSessionListElementClass for tracking session status
oCSharedFileThis class defines a database I/O file service that can be shared by multiple processes
oCSharedMemPagerThe shared mempager uses a mutex to protect key access methods
oCSimpleTCPStreamSimple TCP Stream, to be used with Common C++ Library
oCSingleThreadRTPSessionThis template class adds the threading aspect to the RTPSessionBase template in one of the many possible ways
oCSlogThe slog class is used to stream messages to the system's logging facility (syslogd)
oCSocketThe Socket is used as the base for all Internet protocol services under Common C++
oCSocketPortThe socket port is an internal class which is attached to and then serviced by a specific SocketService "object"
oCSocketServiceThe SocketService is a thread pool object that is meant to service attached socket ports
oCsrtpSecretsThis structure contains pointers to the SRTP secrets and the role info
oCStackPagerThe StackPager provides a repository to stash and retrieve working data in last-in-first-out order
oCStaticPayloadFormatStatic payload format objects
oCStringThis is a generic and portable string class
oCStringObjectUsed to derive subclasses that use the String managed memory pool for all space allocations by overriding new and delete operators
oCStringTokenizerSplits delimited string into tokens
|oCiteratorThe input forward iterator for tokens
|\CNoSuchElementExceptionException thrown, if someone tried to read beyond the end of the tokens
oCSyncSourceSynchronization source in an RTP session
oCSyncSourceHandlerSyncSource objects modification methods
oCSysTimeThis class is used to access non-reentrant date and time functions in the standard C library
oCTCPSessionThe TCP session is used to primarily to represent a client connection that can be managed on a seperate thread
oCTCPSocketTCP sockets are used for stream based connected sessions between two sockets
oCTCPStreamTCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections
oCThreadEvery thread of execution in an application is created by instantiating an object of a class derived from the Thread class
oCThreadFileThis class defines a database I/O file service that can be shared by multiple threads
oCThreadKeyThis 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
oCThreadLockImpliments a thread rwlock for optimal reader performance on systems which have rwlock support, and reverts to a simple mutex for those that do not
oCThreadQueueSomewhat generic queue processing class to establish a producer consumer queue
oCTimeUses a integer representation of the current time
oCTimeoutProviderClass to generate objects giving timeout functionality
oCTimerPortTimer ports are used to provide synchronized timing events when managed under a "service thread" such as SocketService
oCTPRequestProvides a way to request timeouts after a number of milli seconds
oCTTYSessionThe 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
oCTTYStreamTTY streams are used to represent serial connections that are fully "streamable" objects using C++ stream classes and friends
oCttystreamA more natural C++ "ttystream" class for use by non-threaded applications
oCTypeManagerThis class manages the types for generation of the persistent objects
|\CRegistrationThis manages a registration to the typemanager - attempting to remove problems with the optimisers
oCUDPBroadcastRepresenting a UDP socket used for subnet broadcasts, this class provides an alternate binding and setPeer() capability for UDP sockets
oCUDPDuplexUDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts
oCUDPReceiveRepresenting half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet
oCUDPSocketUDP sockets implement the TCP SOCK_DGRAM UDP protocol
oCUDPTransmitRepresenting half of a two-way UDP connection, the UDP transmitter can broadcast data to another selected peer host or to an entire subnet
oCUnixSessionThe Unix domain session is used to primarily to represent a client connection that can be managed on a seperate thread
oCUnixSocketUnix domain sockets are used for stream based connected sessions between processes on the same machine
oCUnixStreamUnix streams are used to represent Unix domain client connections to a local server for accepting client connections
oCunixstreamA more natural C++ "unixstream" class for use by non-threaded applications
oCURLStreamA URL processing version of TCPStream
oCWriteLockUsed to protect a section of code through a ThreadLock for "write" access to the member function
oCXMLRPCThis class impliments a core XMLRPC service without the underlying transports
oCXMLStreamThis class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods
oCzrtp_CallbacksThis structure defines the callback functions required by GNU ZRTP
oCZrtpCallbackThis abstract class defines the callback functions required by GNU ZRTP
oCZrtpConfigureZRTP configuration data
oCZrtpQueueGNU ccRTP extension to support GNU ZRTP
\CZrtpUserCallbackApplication callback methods