Bayonne2 / Common C++ 2 Framework: Data Structures

Bayonne2 / Common C++ 2 Framework

Data Structures

Here are the data structures with brief descriptions:

[detail level 123]

oNGnuZrtpCodes This enum defines the information message severity

|oCAudio Generic audio class to hold master data types and various useful class encapsulated friend functions as per GNU Common C++ 2 coding standard

||oCdtmf_detect_state_t

||oCgoertzel_state_t

||oCInfo Audio source description

||oCmpeg_audio

||oCmpeg_tagv1

||\Ctone_detection_descriptor_t

|oCAudioResample Used to manage linear intropolation buffering for rate conversions

|oCAudioTone Used to create a frame of audio encoded single or dualtones

|oCAudioBase AudioBase base class for many other audio classes which stream data

|oCAudioBuffer For mixing one-to-one soft joins

|oCAudioFile A class used to manipulate audio data

|oCAudioStream AudioStream accesses AudioFile base class content as fixed frames of streaming linear samples

|oCAudioCodec The codec class is a virtual used for transcoding audio samples between linear frames (or other known format) and an encoded "sample" buffer

|oCAudioDevice

|oCTelTone An object that is used to sequence and extract telephony tones based on a telephony tone descriptor retrieved from the parsed international telephony tone database

||oC_tonedef

||\C_tonekey

|oCDTMFTones DTMFTones is used to generate a series of dtmf audio data from a "telephone" number passed as an ASCII string

|oCMFTones MFTones is used to generate a series of mf audio data from a "telephone" number passed as an ASCII string

|oCDTMFDetect DTMFDetect is used for detecting DTMF tones in a stream of audio

|oCStreamingBuffer Streaming buffer for audio, to be used in bgm audio sources

|oCStaticKeydata Bayonnne specific static keydata class

|oCDynamicKeydata Bayonne specific dynamic keydata class

|oCReconfigKeydata Bayonne specific reloaded keydata class

|oCBayonne Generic Bayonne master class to reference various useful data types and core static members used for locating resources found in libbayonne

||oCEvent The event data structure includes the event identifier and any paramaters

||oClibaudio_t

||oCregauth_t

||oCRing This is an internal ring class for synchronized ringing

||oCRPCDefine This is a structure used to initialize XMLRPC method tables

||oCRPCNode This is a little class used to associate XMLRPC call method tables with our server

||oCState The primary state data structure

||oCstatetab A list of each state and a description

||\CTraffic This is a class used for collecting statistics for call traffic measurement, such as might be used by MRTG

|oCBayonneZeroconf This class is used to bind services that are to be published with zeroconf, such as by the avahi module

|oCBayonneConfig A bayonne config class, used for special purposes, especially during script compiles

|oCBayonneTranslator A core class to support language translation services in Bayonne phrasebook

|oCBayonneAudio Offers core Bayonne audio processing in a self contained class

|oCBayonneMsgport Bayonne Msgports are used to queue and post session events which normally have to be passed through another thread context

|oCBayonneDriver The principle driver node for a given collection of spans and sessions of a given Bayonne driver family type

|oCBayonneSpan A span is a collection of ports under a single control interface or communication channel, such as a T1/E1/PRI/BRI span

|oCBayonneBinder An intermediary binder class for Bayonne engine

||\CImage

|oCBayonneSession The primary session object representing a server timeslot and active communication endpoint in Bayonne

|oCBayonneRPC Bayonne RPC arguments, may be passed through to binders from webservice sessions for extensions to soap & xmlrpc services

||\Cparams

|oCBayonneService Bayonne services are used for threaded modules which may be installed at runtime

|oCScriptEngine Offers interface bridge for embedded scripting engines through an abstract interface

|oCLibexec Container class for applications implimenting the libexec process method of Bayonne interfacing

|oCBayonneTSession

|oCBayonneSysexec Core class for any server which impliments libexec functionality

|oCScript Generic script class to hold master data types and various useful class encpasulated friend functions

||oC_array

||oC_symbol

||oCDefine

||oCFun

||oCInitial

||oCInitScript

||oCLine

||oCName

||oCNamedEvent

||oCPackage

||\CTest

|oCScriptSymbols

|oCScriptCommand This class holds the bound keyword set for a given Bayonne style script interpreter

||\C_keyword

|oCScriptBinder

|oCScriptRuntime

|oCScriptRipple

|oCScriptChecks

|oCScriptObject A linkable list of objects that can be destroyed when a script image is removed from memory

|oCScriptImage A derivable class to hold compiled script images for active processes

||\CInitialList

|oCScriptCompiler A derivable class to hold compiled script images for active processes

||\C_merge

|oCScriptInterp

||\CFrame

|oCScriptMethods

|oCScriptThread

|oCScriptRegistry This class is used for registering scripts with an external registry

|\CScriptProperty This class is used for DSO modules that impliment property extensions for scripting objects

oCAlgorithmEnum The algorithm enumration class

oCAppDataUnit Interface (envelope) to data received over RTP packets

oCApplicationHandler Application objects modification methods

oCAppLog Application logger is a class that implements a logger that can be used by applications to save log file somewhere on the system

|\CIdent Ident class that represents module name

oCAssoc This class is used to associate (object) pointers with named strings

|\Centry

oCAtomicCounter Offers thread-safe manipulation of an integer counter

oCAuthLengthEnum

oCAVPQueue This class, an RTP/RTCP queue, adds audio/video profile (AVP) specific methods to the generic RTCP service queue (QueueRTCPManager)

oCBaseObject BaseObject

oCBuffer 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

oCc_srtpSecrets This structure contains pointers to the SRTP secrets and the role info

oCCancellation A class to automatically set the thread cancellation mode of a member function

oCChecksumDigest A simple checksum digest function

oCcistring_char_traits

oCCommandOption CommandOption is the base class for all command line options

oCCommandOptionArg Class for options with an argument e.g

oCCommandOptionCollect It only makes sense to have a single one of these set and it is also exclusive with CommandOptionRest

oCCommandOptionNoArg CommandOption type for flags

oCCommandOptionParse This is the CommandOptionParse interface class

oCCommandOptionRest It only makes sense to have a single one of these set and it is exclusive with CommandOptionCollect

oCCommandOptionWithArg Derived class of CommandOption for options that have a value associated with them

oCConditional A conditional variable synchcronization object for one to one and one to many signal and control events between processes

oCConflictHandler To track addresses of sources conflicting with the local one

|\CConflictingTransportAddress

oCCounter The counter template is used for generic objects which act as automatic counters

oCCRC16Digest A crc16 collection/compution hash accumulator class

oCCRC32Digest A crc32 collection/computation hash accumulator class

oCCryptoContext The implementation for a SRTP cryptographic context

oCCryptoContextCtrl The implementation for a SRTCP cryptographic context

oCDate Uses a julian date representation of the current year, month, and day

oCDateNumber A number class that manipulates a string buffer that is also a date

oCDatetime Uses a julian date representation of the current year, month, and day and a integer representation of the current time

oCDCCPSocket DCCP sockets are used for stream based connected sessions between two sockets

oCDestinationListHandler This class handles a list of destination addresses

|\CTransportAddress

oCDigest The digest base class is used for implementing and deriving one way hashing functions

oCDir A low level portable directory class

oCDirTree A generic class to walk a hierarchical directory structure

oCDSO The DSO dynamic loader class is used to load object files

oCDualRTPChannel

oCDualUDPIPv4Socket A socket class based on two UDP/IPv4 sockets

oCDynamicPayloadFormat Dynamic payload format objects

oCEngine Engine

oCEnumBase EnumBase provides methods to store and access algorithm enumerations of a specific algorithm type

oCEvent Implements a feature originally found in the WIN32 API; event notification

oCFile

|\C_fcb

oCFixedBuffer A buffer class that holds a known capacity of fixed sized objects defined during creation

oCHashEnum The enumaration subclasses that contain the supported algorithm enumerations

oCHEXdump Produces a dump of a buffer in a hexdump way with its code Ascii translation and relative buffer address

oCIncomingDataQueue Queue for incoming RTP data packets in an RTP session

|\CSyncSourcesIterator Iterator through the list of synchronizations sources in this session

oCIncomingDataQueueBase

oCIncomingRTPPkt RTP packets received from other participants

oCIncomingZRTPPkt

oCIPV4Address The network name and address objects are all derived from a common IPV4Address base class

oCIPV4Broadcast The broadcast address object is used to store the broadcast address for a specific subnet

oCIPV4Cidr The CIDR class is used to support routing tables and validate address policies

oCIPV4Host This object is used to hold the actual and valid internet address of a specific host machine that will be accessed through a socket

oCIPV4Mask Internet addresses used specifically as masking addresses (such as " 255.255.255.0") are held in the IPV4Mask derived object

oCIPV4Multicast A specialization of IPV4Address that provides address validation for multicast addresses

oCIPV4MulticastValidator Class for the function object that validates multicast addresses

oCIPV4Validator Classes derived from IPV4Address would require an specific validator to pass to the IPV4Address constructor

oCIZStream

oCKeydata Keydata objects are used to load and hold "configuration" data for a given application

|oCDefine

|oCKeysym

|\CKeyval

oCkeyMap

oCLinkedDouble Self managed double linked list object chain

oCLinkedSingle Self managed single linked list object chain

oCLockfile This class is used to create a "named" lock entity that can be used to control access to a resource between multiple processes

oCMapIndex The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key

oCMapObject The MapObject is a base class which can be used to make a derived class operate on a MapTable

oCMappedFile Create and map a disk file into memory

oCMapTable A map table allows for entities to be mapped (hash index) onto it

oCMD5Digest A md5 collection/computation accululator class

oCMembers Members and senders accounting

oCMembershipBookkeeping Controls the group membership in the current session

|oCIncomingRTPPktLink Incoming RTP data packets control structure within the incoming packet queue class

|\CSyncSourceLink Synchronization Source internal handler within the incoming packets queue

oCMemPager 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

|\C_page

oCMemPagerObject This class is used to create derived classes which are constructed within a memory pager pool

oCMIMEFormData This is a document part type for use in submitting multipart form data to a web server

oCMIMEItemPart This is used to attach an item part to a MIME multipart document that is being streamed

oCMIMEMultipart A container class for multi-part MIME document objects which can be streamed to a std::ostream destination

oCMIMEMultipartForm 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

oCMutex Used to protect a section of code so that at any given time only a single thread can perform the protected operation

oCMutexCounter The Mutex Counter is a counter variable which can safely be incremented or decremented by multiple threads

oCMutexLock Used to protect a section of code so that at any given time only a single thread can perform the protected operation

oCNetworkDeviceInfo Network device information class

oCNumber A number manipulation class

oCobjCounter Generic template class for creating classes which maintain an active count of the number of instances currently in active use

oCobjList Used to create and manage a single linked list of objects of a common type

oCobjMap Used to create and manage a hash index of objects through a common type

oCobjSync 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

oCOutgoingDataQueue A generic outgoing RTP data queue supporting multiple destinations

|\COutgoingRTPPktLink

oCOutgoingDataQueueBase

oCOutgoingRTPPkt RTP packets being sent

oCOutgoingZRTPPkt

oCOZStream

oCParticipant A class of objects representing remote participants (RTP applications) in a multimedia session

oCParticipantHandler Participant objects modification methods

oCPayloadFormat Base payload format class

oCPointer Used to create and manage referece counted pointers

oCPosixThread

oCPredEquals Std equality for SessionListElement objects

oCProcess A class for containing portable process related functions that help create portable code

oCPubKeyEnum

oCQueueRTCPManager Adds generic management of RTCP functions to an RTP data queue

oCRandomFile 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

oCReadLock Used to protect a section of code through a ThreadLock for "read" access to the member function

oCRefObject A reference countable object

oCRefPointer Pointer to reference counted objects

oCRTCPCompoundHandler Low level structs and RTCP packet parsing and building methods

|oCAPPPacket Struct for APP (application specific) RTCP packets

|oCBYEPacket Struct for BYE (leaving session) RTCP packets

|oCFIRPacket Struct for Full Intra-frame Request (FIR) RTCP packet

|oCNACKPacket Struct for Negative ACKnowledgements (NACK) RTCP packet

|oCReceiverInfo Struct for the data contained in a receiver info block

|oCRecvReport Raw structure of the source and every receiver report in an SR or RR RTCP packet

|oCRRBlock Struct for a receiver info block in a SR (sender report) or an RR (receiver report) RTCP packet

|oCRTCPFixedHeader Fixed RTCP packet header

|oCRTCPPacket Struct representing general RTCP packet headers as they are sent through the network

|oCSDESChunk Struct for a chunk of items in a SDES RTCP packet

|oCSDESItem Struct for an item description of a SDES packet

|oCSenderInfo Struct for the sender info block in a SR (sender report) RTCP packet

|\CSendReport Struct for SR (sender report) RTCP packets

oCRTCPReceiverInfo Report block information of SR/RR RTCP reports

oCRTCPSenderInfo Sender block information of SR RTCP reports

oCRTPApplication An RTP application, holding identifying RTCP SDES item values

|oCParticipantLink

|\CParticipantsIterator Iterator through the list of participants in this session

oCRTPBaseUDPIPv4Socket A UDP/IPv4 socket class targetted at RTP stacks

oCRTPDataQueue A packet queue handler for building different kinds of RTP protocol systems

oCRTPDuplex A peer associated RTP socket pair for physically connected peer hosts

oCRTPPacket A base class for both IncomingRTPPkt and OutgoingRTPPkt

|oCRFC2833Payload Structure defining RFC2833 Telephony events

|oCRTPFixedHeader RTP fixed header as it is send through the network

|\CRTPHeaderExt Fixed component of the variable-length header extension, appended to the fixed header, after the CSRC list, when X == 1

oCRTPQueueBase A virtual base class for RTP queue hierarchies

oCRTPSessionBase Generic RTP protocol stack for exchange of realtime data

oCRTPSessionBaseHandler

oCRTPSessionPool This class is a base class for classes that define a group of RTP sessions that will be served by one or more execution threads

oCRunable A container for objects that can be queued against a runlist

oCRunlist A runlist is used to restrict concurrent exection to a limited set of concurrent sessions, much like a semaphore

oCSasTypeEnum

oCSDESItemsHolder Holds the SDES items and related information from a participant in an RTP application

oCSemaphore 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

oCSemaphoreLock Used to protect a section of code through a semaphore so that only x instances of the member function may execute concurrently

oCSerial Used as the base for all serial I/O services under APE

oCSerialPort The serial port is an internal class which is attached to and then serviced by a specified SerialService thread

oCSerialService The SerialService is a thead service object that is meant to service attached serial ports

oCServiceQueue

oCSessionListElement Class for tracking session status

oCSharedFile This class defines a database I/O file service that can be shared by multiple processes

oCSharedMemPager The shared mempager uses a mutex to protect key access methods

oCSimpleTCPStream Simple TCP Stream, to be used with Common C++ Library

oCSingleRTPSessionPool

oCSingleThreadRTPSession This template class adds the threading aspect to the RTPSessionBase template in one of the many possible ways

oCSlog The slog class is used to stream messages to the system's logging facility (syslogd)

oCSocket The Socket is used as the base for all Internet protocol services under Common C++

oCSocketPort The socket port is an internal class which is attached to and then serviced by a specific SocketService "object"

oCSocketService The SocketService is a thread pool object that is meant to service attached socket ports

oCsrtpSecrets This structure contains pointers to the SRTP secrets and the role info

oCSString

oCStackPager The StackPager provides a repository to stash and retrieve working data in last-in-first-out order

|\Cframe

oCStaticPayloadFormat Static payload format objects

oCString This is a generic and portable string class

oCStringObject Used to derive subclasses that use the String managed memory pool for all space allocations by overriding new and delete operators

oCStringTokenizer Splits delimited string into tokens

|oCiterator The input forward iterator for tokens

|\CNoSuchElementException Exception thrown, if someone tried to read beyond the end of the tokens

oCSymCipherEnum

oCSyncSource Synchronization source in an RTP session

oCSyncSourceHandler SyncSource objects modification methods

oCSysTime This class is used to access non-reentrant date and time functions in the standard C library

oCTCPSession The TCP session is used to primarily to represent a client connection that can be managed on a seperate thread

oCTCPSocket TCP sockets are used for stream based connected sessions between two sockets

oCTCPStream TCP streams are used to represent TCP client connections to a server by TCP protocol servers for accepting client connections

oCThread Every thread of execution in an application is created by instantiating an object of a class derived from the Thread class

oCThreadFile This class defines a database I/O file service that can be shared by multiple threads

oCThreadKey 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

oCThreadLock 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

oCThreadQueue Somewhat generic queue processing class to establish a producer consumer queue

|\C_data

oCTime Uses a integer representation of the current time

oCTimeoutProvider Class to generate objects giving timeout functionality

oCTimerPort Timer ports are used to provide synchronized timing events when managed under a "service thread" such as SocketService

oCTPRequest Provides a way to request timeouts after a number of milli seconds

oCTRTPSessionBase

oCTTYSession 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

oCTTYStream TTY streams are used to represent serial connections that are fully "streamable" objects using C++ stream classes and friends

oCttystream A more natural C++ "ttystream" class for use by non-threaded applications

oCTypeManager This class manages the types for generation of the persistent objects

|\CRegistration This manages a registration to the typemanager - attempting to remove problems with the optimisers

oCUDPBroadcast Representing a UDP socket used for subnet broadcasts, this class provides an alternate binding and setPeer() capability for UDP sockets

oCUDPDuplex UDP duplex connections impliment a bi-directional point-to-point UDP session between two peer hosts

oCUDPReceive Representing half of a two-way UDP connection, the UDP receiver can receive data from another peer host or subnet

oCUDPSocket UDP sockets implement the TCP SOCK_DGRAM UDP protocol

oCUDPTransmit Representing half of a two-way UDP connection, the UDP transmitter can broadcast data to another selected peer host or to an entire subnet

oCUnixSession The Unix domain session is used to primarily to represent a client connection that can be managed on a seperate thread

oCUnixSocket Unix domain sockets are used for stream based connected sessions between processes on the same machine

oCUnixStream Unix streams are used to represent Unix domain client connections to a local server for accepting client connections

oCunixstream A more natural C++ "unixstream" class for use by non-threaded applications

oCURLStream A URL processing version of TCPStream

oCWriteLock Used to protect a section of code through a ThreadLock for "write" access to the member function

oCXMLRPC This class impliments a core XMLRPC service without the underlying transports

oCXMLStream This class impliments a basic XML stream parser that can be used to examine an XML resource thru virtual I/O methods

oCZNumber

oCzrtp_Callbacks This structure defines the callback functions required by GNU ZRTP

oCZrtpCallback This abstract class defines the callback functions required by GNU ZRTP

oCZrtpConfigure ZRTP configuration data

oCzrtpContext

oCZrtpQueue GNU ccRTP extension to support GNU ZRTP

\CZrtpUserCallback Application callback methods

Generated on Dec 21, 2017 for commoncpp2-1.8.1, ccrtp-1.7.2, libzrtpcpp-2.3.4, ccscript3-1.1.7, ccaudio2-1.0.0 and bayonne2-2.3.2 (after installation in /usr/local/) by doxygen 1.8.6