namespace TelEngine

Holds all Telephony Engine related classes. More...

List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Public Members


Detailed Description

Holds all Telephony Engine related classes.

void  abortOnBug ()

abortOnBug

Abort execution (and coredump if allowed) if the abort flag is set. This function may not return.

bool  abortOnBug (bool doAbort)

abortOnBug

Set the abort on bug flag. The default flag state is false.

Returns: The old state of the flag.

enum DebugLevel { DebugFail = 0, DebugTest = 1, DebugGoOn = 2, DebugConf = 3, DebugStub = 4, DebugWarn = 5, DebugMild = 6, DebugCall = 7, DebugNote = 8, DebugInfo = 9, DebugAll = 10 }

DebugLevel

Standard debugging levels. The DebugFail level is special - it is always displayed and may abort the program if abortOnBug() is set.

int  debugLevel ()

debugLevel

Retrieve the current global debug level

Returns: The current global debug level

int  debugLevel (int level)

debugLevel

Set the current global debug level.

Parameters:
levelThe desired debug level

Returns: The new global debug level (may be different)

bool  debugAt (int level)

debugAt

Check if debugging output should be generated

Parameters:
levelThe global debug level we are testing

Returns: True if messages should be output, false otherwise

const char*  debugColor (int level)

debugColor

Get an ANSI string to colorize debugging output

Parameters:
levelThe debug level who's color is requested. Negative or out of range will reset to the default color

Returns: ANSI string that sets color corresponding to level

const char*  debugLevelName (int level)

debugLevelName

Get the name of a debugging or alarm level

Parameters:
levelThe debug level

Returns: Short C string describing the level

DebugEnabler (class)

DebugEnabler

Holds a local debugging level that can be modified separately from the global debugging

void  DDebug (int level, const char* format, ...)

DDebug

Convenience macro. Does the same as Debug if DEBUG is \#defined (compiling for debugging) else it does not get compiled at all.

void  DDebug (const char* facility, int level, const char* format, ...)

DDebug

Convenience macro. Does the same as Debug if DEBUG is \#defined (compiling for debugging) else it does not get compiled at all.

void  DDebug (const DebugEnabler* local, int level, const char* format, ...)

DDebug

Convenience macro. Does the same as Debug if DEBUG is \#defined (compiling for debugging) else it does not get compiled at all.

void  XDebug (int level, const char* format, ...)

XDebug

Convenience macro. Does the same as Debug if XDEBUG is \#defined (compiling for extra debugging) else it does not get compiled at all.

void  XDebug (const char* facility, int level, const char* format, ...)

XDebug

Convenience macro. Does the same as Debug if XDEBUG is \#defined (compiling for extra debugging) else it does not get compiled at all.

void  XDebug (const DebugEnabler* local, int level, const char* format, ...)

XDebug

Convenience macro. Does the same as Debug if XDEBUG is \#defined (compiling for extra debugging) else it does not get compiled at all.

void  NDebug (int level, const char* format, ...)

NDebug

Convenience macro. Does the same as Debug if NDEBUG is not \#defined else it does not get compiled at all (compiling for mature release).

void  NDebug (const char* facility, int level, const char* format, ...)

NDebug

Convenience macro. Does the same as Debug if NDEBUG is not \#defined else it does not get compiled at all (compiling for mature release).

void  NDebug (const DebugEnabler* local, int level, const char* format, ...)

NDebug

Convenience macro. Does the same as Debug if NDEBUG is not \#defined else it does not get compiled at all (compiling for mature release).

void  Debug (int level, const char* format, ...)

Debug

Outputs a debug string.

Parameters:
levelThe level of the message
formatA printf() style format string

void  Debug (const char* facility, int level, const char* format, ...)

Debug

Outputs a debug string for a specific facility.

Parameters:
facilityFacility that outputs the message
levelThe level of the message
formatA printf() style format string

void  Debug (const DebugEnabler* local, int level, const char* format, ...)

Debug

Outputs a debug string for a specific facility.

Parameters:
localPointer to a DebugEnabler holding current debugging settings
levelThe level of the message
formatA printf() style format string

void  Alarm (const char* component, int level, const char* format, ...)

Alarm

Outputs a debug string and emits an alarm if a callback is installed

Parameters:
componentComponent that emits the alarm
levelThe level of the alarm
formatA printf() style format string

void  Alarm (const DebugEnabler* component, int level, const char* format, ...)

Alarm

Outputs a debug string and emits an alarm if a callback is installed

Parameters:
componentPointer to a DebugEnabler holding component name and debugging settings
levelThe level of the alarm
formatA printf() style format string

void  Alarm (const char* component, const char* info, int level, const char* format, ...)

Alarm

Outputs a debug string and emits an alarm if a callback is installed

Parameters:
componentComponent that emits the alarm
infoExtra alarm information
levelThe level of the alarm
formatA printf() style format string

void  Alarm (const DebugEnabler* component, const char* info, int level, const char* format, ...)

Alarm

Outputs a debug string and emits an alarm if a callback is installed

Parameters:
componentPointer to a DebugEnabler holding component name and debugging settings
infoExtra alarm information
levelThe level of the alarm
formatA printf() style format string

void  Output (const char* format, ...)

Output

Outputs a string to the debug console with formatting

Parameters:
formatA printf() style format string

Debugger (class)

Debugger

This class is used as an automatic variable that logs messages on creation and destruction (when the instruction block is left or function returns). IMPORTANT: the name is not copied so it should best be static.

TokenDict (struct)

TokenDict

A structure to build (mainly static) Token-to-ID translation tables. A table of such structures must end with an entry with a null token

String (class)

String

A simple string handling class for C style (one byte) strings. For simplicity and read speed no copy-on-write is performed. Strings have hash capabilities and comparations are using the hash for fast inequality check.

Mutex (class)

Mutex

A simple mutual exclusion for locking access between threads

ObjList (class)

ObjList

A simple single-linked object list handling class

NamedCounter (class)

NamedCounter

An atomic counter with an associated name

constant  YSTRING (const char* string)

YSTRING

Macro to create a local static String if supported by compiler, use with caution

Parameters:
stringLiteral constant string

Returns: A const String& if supported, literal string if not supported

constant  YATOM (const char* string)

YATOM

Macro to create a shared static String if supported by compiler, use with caution

Parameters:
stringLiteral constant string

Returns: A const String& if supported, literal string if not supported

void  YCLASS (class type,class base)

YCLASS

Macro to create a GenObject class from a base class and implement GenObject::getObject

Parameters:
typeClass that is declared
baseBase class that is inherited

void  YCLASS2 (class type,class base1,class base2)

YCLASS2

Macro to create a GenObject class from two base classes and implement GenObject::getObject

Parameters:
typeClass that is declared
base1First base class that is inherited
base2Second base class that is inherited

void  YCLASS3 (class type,class base1,class base2,class base3)

YCLASS3

Macro to create a GenObject class from three base classes and implement GenObject::getObject

Parameters:
typeClass that is declared
base1First base class that is inherited
base2Second base class that is inherited
base3Third base class that is inherited

void  YCLASSIMP (class type,class base)

YCLASSIMP

Macro to implement GenObject::getObject in a derived class

Parameters:
typeClass that is declared
baseBase class that is inherited

void  YCLASSIMP2 (class type,class base1,class base2)

YCLASSIMP2

Macro to implement GenObject::getObject in a derived class

Parameters:
typeClass that is declared
base1First base class that is inherited
base2Second base class that is inherited

void  YCLASSIMP3 (class type,class base1,class base2,class base3)

YCLASSIMP3

Macro to implement GenObject::getObject in a derived class

Parameters:
typeClass that is declared
base1First base class that is inherited
base2Second base class that is inherited
base3Third base class that is inherited

class*  YOBJECT (class type,GenObject* pntr)

YOBJECT

Macro to retrieve a typed pointer to an interface from an object

Parameters:
typeClass we want to return
pntrPointer to the object we want to get the interface from

Returns: Pointer to the class we want or NULL

void  YNOCOPY (class type)

YNOCOPY

Macro to disable automatic copy and assignment operators

Parameters:
typeClass that is declared

GenObject (class)

GenObject

An object with just a public virtual destructor

inline void  destruct (GenObject* obj)

destruct

Helper function that destroys a GenObject only if the pointer is non-NULL. Use it instead of the delete operator.

Parameters:
objPointer (rvalue) to the object to destroy

template void  destruct (Obj*& obj)

destruct

Helper template function that destroys a GenObject descendant if the pointer is non-NULL and also zeros out the pointer. Use it instead of the delete operator.

Parameters:
objReference to pointer (lvalue) to the object to destroy

RefObject (class)

RefObject

A reference counted object. Whenever using multiple inheritance you should inherit this class virtually.

RefPointerBase (class)

RefPointerBase

Internal helper class providing a non-inline method to RefPointer. Please don't use this class directly, use RefPointer instead.

RefPointer (class)

RefPointer

GenPointer (class)

GenPointer

ObjVector (class)

ObjVector

Simple vector class that holds objects derived from GenObject

Array (class)

Array

A simple Array class derivated from RefObject It uses one ObjList to keep the pointers to other ObjList's. Data is organized in columns - the main ObjList holds pointers to one ObjList for each column. This class has been written by Diana

Regexp (class)

Regexp

A regular expression matching class.

UChar (class)

UChar

A simple class to hold a single Unicode character and convert it to / from UTF-8

inline const char*  c_str (const String* str)

c_str

Utility function to retrieve a C string from a possibly NULL String pointer

Parameters:
strPointer to a String that may be NULL

Returns: String data pointer or NULL

inline const char*  c_safe (const char* str)

c_safe

Utility function to replace NULL C string pointers with an empty C string

Parameters:
strPointer to a C string that may be NULL

Returns: Original pointer or pointer to an empty C string

inline const char*  c_safe (const String* str)

c_safe

Utility function to replace NULL String pointers with an empty C string

Parameters:
strPointer to a String that may be NULL

Returns: String data pointer or pointer to an empty C string

inline bool  null (const char* str)

null

Utility function to check if a C string is null or empty

Parameters:
strPointer to a C string

Returns: True if str is NULL or starts with a NUL character

inline bool  null (const String* str)

null

Utility function to check if a String is null or empty

Parameters:
strPointer to a String

Returns: True if str is NULL or is empty

String  operator+ (const String& s1, const String& s2)

operator+

Concatenation operator for strings.

String  operator+ (const String& s1, const char* s2)

operator+

Concatenation operator for strings.

String  operator+ (const char* s1, const String& s2)

operator+

Concatenation operator for strings.

inline const char * strcpy (String& dest, const char* src)

strcpy

Prevent careless programmers from overwriting the string

See also: operator=

inline const char * strcat (String& dest, const char* src)

strcat

Prevent careless programmers from overwriting the string

See also: operator+=

int  lookup (const char* str, const TokenDict* tokens, int defvalue = 0, int base = 0)

lookup

Utility function to look up a string in a token table, interpret as number if it fails

Parameters:
strString to look up
tokensPointer to the token table
defvalueValue to return if lookup and conversion fail
baseDefault base to use to convert to number

const char*  lookup (int value, const TokenDict* tokens, const char* defvalue = 0)

lookup

Utility function to look up a number in a token table

Parameters:
valueValue to search for
tokensPointer to the token table
defvalueValue to return if lookup fails

NamedList (class)

NamedList

This class holds a named list of named strings

bool  controlReturn (NamedList* params, bool ret, const char* retVal = 0)

controlReturn

Utility method to return from a chan.control handler

Parameters:
paramsThe parameters list
retThe return value
retValThe error message

Returns: ret if the message was not generated from rmanager.

Atom (class)

Atom

Indirected shared string offering access to atom strings

CapturedEvent (class)

CapturedEvent

Holder for an event (output, debug or alarm) message

NamedString (class)

NamedString

A string class with a hashed string name

NamedPointer (class)

NamedPointer

A named string holding a pointer to arbitrary data. The pointer is owned by the object: it will be released when the object is destroyed or the string value changed

HashList (class)

HashList

A hashed object list handling class. Objects placed in the list are distributed according to their String hash resulting in faster searches. On the other hand an object placed in a hashed list must never change its String value or it becomes unfindable.

ListIterator (class)

ListIterator

An ObjList or HashList iterator that can be used even when list elements are changed while iterating. Note that it will not detect that an item was removed and another with the same address was inserted back in list.

Time (class)

Time

The Time class holds a time moment with microsecond accuracy

Random (class)

Random

Implementation of a system independent pseudo random number generator

DataBlock (class)

DataBlock

The DataBlock holds a data buffer with no specific formatting.

Hasher (class)

Hasher

Abstract base class representing a hash calculator

MD5 (class)

MD5

A class to compute and check MD5 digests

SHA1 (class)

SHA1

A class to compute and check SHA1 digests

SHA256 (class)

SHA256

A class to compute and check SHA256 digests

Base64 (class)

Base64

Base64 encoder/decoder class

NamedIterator (class)

NamedIterator

An iterator for NamedString parameters of a NamedList. Fast but unsafe, the list must not be modified during iteration.

URI (class)

URI

Uniform Resource Identifier encapsulation and parser. For efficiency reason the parsing is delayed as long as possible

Lockable (class)

Lockable

An abstract base class for implementing lockable objects

MutexPool (class)

MutexPool

This class holds a Mutex array. Mutexes can be retrieved based on object pointers. A mutex pool can be used to associate a smaller set of Mutex objects with a much larger set of objects needing lock.

Semaphore (class)

Semaphore

A semaphore object for synchronizing threads, can also be used as a token bucket

Lock (class)

Lock

A lock is a stack allocated (automatic) object that locks a lockable object on creation and unlocks it on destruction - typically when exiting a block

Lock2 (class)

Lock2

A dual lock is a stack allocated (automatic) object that locks a pair of mutexes on creation and unlocks them on destruction. The mutexes are always locked in the same order to prevent trivial deadlocks

Runnable (class)

Runnable

This class holds the action to execute a certain task, usually in a different execution thread.

Thread (class)

Thread

A thread is a separate execution context that exists in the same address space. Threads make better use of multiple processor machines and allow blocking one execution thread while allowing other to run.

TempObjectCounter (class)

TempObjectCounter

This class changes the current thread's object counter for its lifetime

Socket (class)

Socket

This class encapsulates a system dependent socket in a system independent abstraction

SocketAddr (class)

SocketAddr

Wrapper class to keep a socket address

SocketFilter (class)

SocketFilter

Abstract interface for an object that filters socket received data packets

Stream (class)

Stream

Base class for encapsulating system dependent stream capable objects

MemoryStream (class)

MemoryStream

An implementation of a Stream that reads and writes data in a DataBlock

File (class)

File

Class to encapsulate a system dependent file in a system independent abstraction

SctpSocket (class)

SctpSocket

The SctpSocket interface provides access to SCTP specific functions

DnsRecord (class)

DnsRecord

This class holds a DNS (resolver) record

TxtRecord (class)

TxtRecord

This class holds a A, AAAA or TXT record from DNS

SrvRecord (class)

SrvRecord

This class holds a SRV (Service Location) record

NaptrRecord (class)

NaptrRecord

This class holds a NAPTR (Naming Authority Pointer) record

Resolver (class)

Resolver

This class offers DNS query services

Cipher (class)

Cipher

The Cipher class provides an abstraction for data encryption classes

Compressor (class)

Compressor

The Compressor class provides an abstraction for data (de)compressor classes. The String component keeps an optional object name to be used for debug purposes

SysUsage (class)

SysUsage

The SysUsage class allows collecting some statistics about engine's usage of system resources

MimeHeaderLine (class)

MimeHeaderLine

A MIME header line. The NamedString's value contain the first parameter after the header name

MimeAuthLine (class)

MimeAuthLine

A MIME header line containing authentication data.

MimeBody (class)

MimeBody

Abstract base class for holding Multipurpose Internet Mail Extensions data. Keeps a Content-Type header line with body type and parameters and any additional header lines the body may have. The body type contains lower case characters.

MimeMultipartBody (class)

MimeMultipartBody

An object holding the bodies of a multipart MIME

MimeSdpBody (class)

MimeSdpBody

An object holding the lines of an application/sdp MIME type

MimeBinaryBody (class)

MimeBinaryBody

An object holding a binary block of MIME data

MimeStringBody (class)

MimeStringBody

An object holding MIME data as just one text string

MimeLinesBody (class)

MimeLinesBody

An object holding MIME data as separate text lines

Configuration (class)

Configuration

A class for parsing and quickly accessing INI style configuration files

SharedVars (class)

SharedVars

Class that implements atomic / locked access and operations to its shared variables

MessageDispatcher (class)

MessageDispatcher

The dispatcher class is a hub that holds a list of handlers to be called for the messages that pass trough the hub. It can also handle a queue of messages that are typically dispatched by a separate thread.

MessageRelay (class)

MessageRelay

A message handler that allows to relay several messages to a single receiver

Engine (class)

Engine

This class holds global information about the engine. Note: this is a singleton class.

Message (class)

Message

This class holds the messages that are moved around in the engine.

MessageHandler (class)

MessageHandler

The purpose of this class is to hold a message received method that is called for matching messages. It holds as well the matching criteria and priority among other handlers.

MessageReceiver (class)

MessageReceiver

A multiple message receiver to be invoked by a message relay

MessageNotifier (class)

MessageNotifier

An abstract class to implement hook methods called after any message has been dispatched. If an object implementing MessageNotifier is set as user data in a Message then the dispatched() method will be called.

MessagePostHook (class)

MessagePostHook

An abstract message notifier that can be inserted in a MessageDispatcher to implement hook methods called after any message has been dispatched. No new methods are provided - we only need the multiple inheritance.

MessageHook (class)

MessageHook

Abstract class for message hook

MessageQueue (class)

MessageQueue

MessageQueue class allows to create a private queue for a message who matches the specified filters.

Plugin (class)

Plugin

Initialization and information about plugins. Plugins are located in shared libraries that are loaded at runtime.


 // Create static Plugin object by using the provided macro
 INIT_PLUGIN(Plugin);

void  INIT_PLUGIN (class pclass)

INIT_PLUGIN

Macro to create static instance of the plugin

Parameters:
pclassClass of the plugin to create

bool  UNLOAD_PLUGIN (bool unloadNow)

UNLOAD_PLUGIN

Macro to create the unloading function

Parameters:
unloadNowTrue if asked to unload immediately, false if just checking

Returns: True if the plugin can be unloaded, false if not

EngineCheck (class)

EngineCheck

Base class for engine running stage checkers. Descendants may check specific conditions and decide to stop the engine. There should be only one (static) instance of an engine checker

typedef int  (*EngineLoop) ()

(*EngineLoop)

Prototype for engine main loop callback

ImageInfo (struct)

ImageInfo

A structure to hold information about a static picture or video frame.

FormatInfo (struct)

FormatInfo

A structure to hold information about a data format.

DataEndpoint (class)

DataEndpoint

The DataEndpoint holds an endpoint capable of performing unidirectional or bidirectional data transfers

CallEndpoint (class)

CallEndpoint

A class that holds common call control and data related features

Driver (class)

Driver

Driver is a module specialized for implementing channel drivers

TranslatorCaps (struct)

TranslatorCaps

A structure to build (mainly static) translator capability tables. A table of such structures must end with an entry with null format names.

FormatRepository (class)

FormatRepository

This is just a holder for the list of media formats supported by Yate

DataFormat (class)

DataFormat

An extension of a String that can parse data formats

DataNode (class)

DataNode

A generic data handling object

DataSource (class)

DataSource

A data source

DataTranslator (class)

DataTranslator

The DataTranslator holds a translator (codec) capable of unidirectional conversion of data from one type to another.

TranslatorFactory (class)

TranslatorFactory

A factory for constructing data translators by format name conversion of data from one type to another

DataConsumer (class)

DataConsumer

A data consumer

ThreadedSource (class)

ThreadedSource

A data source with a thread of its own

Module (class)

Module

Module is a descendent of Plugin specialized in implementing modules

Channel (class)

Channel

A class that holds common channel related features (a.k.a. call leg)

Router (class)

Router

Asynchronous call routing thread

bool  isE164 (const char* str)

isE164

Find if a string appears to be an E164 phone number

Parameters:
strString to check

Returns: True if str appears to be a valid E164 number

Flags32 (class)

Flags32

This class keeps a 32bit length flag mask

NamedInt (class)

NamedInt

This class holds a name integer value

Window (class)

Window

A window is the basic user interface element. Everything inside is implementation specific functionality.

UIWidget (class)

UIWidget

UIFactory (class)

UIFactory

Each instance of UIFactory creates special user interface elements by type. Keeps a global list with all factories. The list doesn't own the facotries

Client (class)

Client

Singleton class that holds the User Interface's main methods

ClientChannel (class)

ClientChannel

This class implements a Channel used by client programs

ClientDriver (class)

ClientDriver

Abstract client Driver that implements some of the specific functionality

ClientLogic (class)

ClientLogic

This class implements the logic behind different actions in the client. It specifies the way the graphical interface of the client will behave in different circumstances.

DefaultLogic (class)

DefaultLogic

This class implements the default client behaviour.

ClientAccount (class)

ClientAccount

This class holds an account

ClientAccountList (class)

ClientAccountList

This class holds an account list

ClientContact (class)

ClientContact

A client contact The contact is using the owner's mutex to lock it's operations

ClientResource (class)

ClientResource

This class holds data about a client account/contact resource

MucRoomMember (class)

MucRoomMember

This class holds data about a MUC room member. The resource name holds the nickname

MucRoom (class)

MucRoom

This class holds a client account's MUC room contact. The list of resources contains MucRoomMember items. Contact nick is held by own MucRoomMember name The contact uri is the room uri The contact name is the room name The contact resource member uri is the account's uri

DurationUpdate (class)

DurationUpdate

Class used to update UI durations. The string keeps the object's id. This object can be used to keep additional data associated with a client channel

ClientSound (class)

ClientSound

This class holds a sound file along with an output device used to play it

ClientFileItem (class)

ClientFileItem

Base class for file/dir items

ClientDir (class)

ClientDir

This class holds directory info

ClientFile (class)

ClientFile

This class holds file info

XmlSaxParser (class)

XmlSaxParser

A Serial Access Parser (SAX) for arbitrary XML data

XmlDomParser (class)

XmlDomParser

A Document Object Model (DOM) parser for XML documents and fragments

XmlDeclaration (class)

XmlDeclaration

Xml Declaration for Xml document

XmlFragment (class)

XmlFragment

Xml Fragment a fragment from a Xml document

XmlChild (class)

XmlChild

Xml Child for Xml document

XmlParent (class)

XmlParent

Xml Parent for a Xml child

XmlDocument (class)

XmlDocument

Xml Document

XmlElement (class)

XmlElement

Xml Element from a Xml document

XmlComment (class)

XmlComment

A Xml Comment from Xml document

XmlCData (class)

XmlCData

A Xml CData from Xml document

XmlText (class)

XmlText

A Xml Declaration for Xml document

XmlDoctype (class)

XmlDoctype

XmlEscape (struct)

XmlEscape

AsnObject (class)

AsnObject

Abstract class implemented by all ASN.1 type objects

AsnValue (class)

AsnValue

Class wrapper for different types of ASN.1 values

ASNObjId (class)

ASNObjId

Class for holding only an OID

ASNLib (class)

ASNLib

Class ASNLib

OctetString (class)

OctetString

Helper class for operations with octet strings. Helps with conversions from String to/from DataBlock

AsnMib (class)

AsnMib

Class describing an ASN.1 OID

AsnTag (class)

AsnTag

Class AsnTag

GSML3Codec (class)

GSML3Codec

IAXInfoElement (class)

IAXInfoElement

This class holds a single Information Element with no data

IAXInfoElementString (class)

IAXInfoElementString

This class holds a single Information Element with text data

IAXInfoElementNumeric (class)

IAXInfoElementNumeric

This class holds a single Information Element with 1, 2 or 4 byte(s) length data

IAXInfoElementBinary (class)

IAXInfoElementBinary

This class holds a single Information Element with binary data

IAXIEList (class)

IAXIEList

Management class for a list of Information Elements

IAXAuthMethod (class)

IAXAuthMethod

This class holds the enumeration values for authentication methods

IAXFormatDesc (class)

IAXFormatDesc

This class holds IAX format description

IAXFormat (class)

IAXFormat

This class holds the enumeration values for audio and video formats

IAXControl (class)

IAXControl

This class holds the enumeration values for IAX control (subclass)

IAXFrame (class)

IAXFrame

This class holds all data needded to manage an IAX frame

IAXFullFrame (class)

IAXFullFrame

This class holds all data needded to manage an IAX full frame

IAXFrameOut (class)

IAXFrameOut

This class holds all data needded to manage an outgoing IAX full frame

IAXTrunkInfo (class)

IAXTrunkInfo

This class holds trunk description

IAXMetaTrunkFrame (class)

IAXMetaTrunkFrame

Handle meta trunk frame with timestamps

IAXMediaData (class)

IAXMediaData

This class holds data used by transaction to sync media. The mutexes are not reentrant

IAXTransaction (class)

IAXTransaction

This class holds all the data needded for the management of an IAX2 transaction which might be a call leg, a register/unregister or a poke one

IAXEvent (class)

IAXEvent

This class holds an event generated by a transaction

IAXEngine (class)

IAXEngine

This class holds all information needded to manipulate all IAX transactions and events

StringArray (class)

StringArray

Implements a String array set from an already allocated

XMPPNamespace (class)

XMPPNamespace

This class holds the XMPP/Jabber/Jingle namespace enumerations and the associated strings

XMPPError (class)

XMPPError

This class holds the XMPP error type, error enumerations and associated strings

JabberID (class)

JabberID

This class holds a Jabber ID

JIDIdentity (class)

JIDIdentity

This class holds an identity for a JID See http://xmpp.org/registrar/disco-categories.html for identity categories and associated types

JIDIdentityList (class)

JIDIdentityList

This class holds a list of JID identities

XMPPFeature (class)

XMPPFeature

This class holds an XMPP feature

XMPPFeatureSasl (class)

XMPPFeatureSasl

This class holds a SASL feature along with authentication mechanisms

XMPPFeatureCompress (class)

XMPPFeatureCompress

This class holds a compression feature along with compression methods

XMPPFeatureList (class)

XMPPFeatureList

This class holds a list of JID features

XMPPUtils (class)

XMPPUtils

This class is a general XMPP utilities

XMPPDirVal (class)

XMPPDirVal

This class holds a direction flags (such as subscription states)

XmlElementOut (class)

XmlElementOut

This class holds an XML element to be sent through a stream

XmlTag (class)

XmlTag

This class holds a list of XML tags

SASL (class)

SASL

This class handles PLAIN (rfc 4616) and DIGEST (rfc 2831) SASL authentication

JBEvent (class)

JBEvent

This class holds a Jabber stream event. Stream events are raised by streams and sent by the engine to the proper service

JBStream (class)

JBStream

Base class for all Jabber streams. Basic stream data processing: send/receive XML elements, keep stream state, generate events

JBClientStream (class)

JBClientStream

This class holds a client to server stream

JBServerStream (class)

JBServerStream

This class holds a server to server stream

JBClusterStream (class)

JBClusterStream

This class holds a cluster stream

JBRemoteDomainDef (class)

JBRemoteDomainDef

This class holds data related to a remote domain. The String holds the domain

JBConnect (class)

JBConnect

This class holds data used to connect an outgoing stream A descendant class should implement the thread run method

JBEngine (class)

JBEngine

This class holds a Jabber engine

JBServerEngine (class)

JBServerEngine

This class implements a Jabber server engine

JBClientEngine (class)

JBClientEngine

This class implements a Jabber client engine

JBStreamSet (class)

JBStreamSet

This class holds a set of streams to be processed in an uniform way. This is a base class for specialized stream list processors. Its process() method should be called in its own thread

JBStreamSetProcessor (class)

JBStreamSetProcessor

This class holds a set specialized in stream processing

JBStreamSetReceive (class)

JBStreamSetReceive

This class holds a set specialized in stream data receiver

JBStreamSetList (class)

JBStreamSetList

This class holds a list of stream sets. The purpose is to create a list of threads

JBEntityCaps (class)

JBEntityCaps

This class holds entity capability data Implements XEP 0115 support

JBEntityCapsList (class)

JBEntityCapsList

This class holds data and offer entity capability services. Implements XEP 0115 support

JGRtpMedia (class)

JGRtpMedia

This class holds a Jingle data payload description

JGCrypto (class)

JGCrypto

This class holds a content description's crypto data. The tag is kept in the String component

JGRtpMediaList (class)

JGRtpMediaList

Hold a list of RTP data payloads

JGRtpCandidate (class)

JGRtpCandidate

This class holds a RTP transport candidate

JGRtpCandidates (class)

JGRtpCandidates

This class holds a list of jingle RTP transport candidates

JGSessionContent (class)

JGSessionContent

This class holds a Jingle content negotiated during a session It can be built from a received xml element and it can build an xml element from itself

JGStreamHost (class)

JGStreamHost

This class holds a file transfer stream host definition

JGSession (class)

JGSession

This class is a base class for all specific jingle sessions

JGSession0 (class)

JGSession0

A session implementing the old jingle protocol

JGSession1 (class)

JGSession1

A session implementing the Jingle protocol including session transfer and file transfer

JGEvent (class)

JGEvent

This class holds an event generated by a Jingle session

JGEngine (class)

JGEngine

This class holds a Jingle service for the Jabber engine. Handle jingle stanzas, stanza write fail events and stream termination events

JGSentStanza (class)

JGSentStanza

This class holds sent stanzas info used for timeout checking

JGRtpCandidateP2P (class)

JGRtpCandidateP2P

This class holds a RTP transport candidate

MGCPMessage (class)

MGCPMessage

This class holds an MGCP message, either command or response, along with its parameters. The

MGCPTransaction (class)

MGCPTransaction

This class implements an MGCP transaction

MGCPEpInfo (class)

MGCPEpInfo

This class holds data about a remote endpoint (id and address)

MGCPEndpoint (class)

MGCPEndpoint

This class holds a local MGCP endpoint (either gateway or call agent) along with its remote peer(s). If the engine owning this endpoint is an MGCP gateway, only 1 remote peer (Call Agent) is allowed

MGCPEvent (class)

MGCPEvent

This class carries a copy of the message received by a transaction or a transaction state change notification (such as timeout or destroy)

MGCPEngine (class)

MGCPEngine

The engine may keep gateway endpoints or call agents Keep the transaction list and manage it (create/delete/modify/timeout...) Keep a list with the endpoints it services Generate transaction numbers (IDs) Parse received messages, validate and send them to the appropriate transaction Send MGCP messages to remote addresses

MGCPEndpointId (class)

MGCPEndpointId

This class holds an endpoint id in the form "endpoint@host:port"

BitAccumulator (class)

BitAccumulator

This class encapsulates an 8 bits length buffer used to accumulate bits

FSKModem (class)

FSKModem

This is a modulator/demodulator class attached to an UART. Used to demodulate bits from frequency modulated signal and send them to an UART

UART (class)

UART

Accumulate data bits received from a modem

UARTBuffer (class)

UARTBuffer

This class is used by an UART to accumulate messages with known length

ETSIModem (class)

ETSIModem

This class implements a modem/UART pair used to demodulate/decode analog signal as defined in ETSI EN 300 659-1, ETSI EN 300 659-2, ETSI EN 300 659-3

CallInfo (class)

CallInfo

Hold extra informations about an active CallEndpoint

CallList (class)

CallList

Hold a list of call informations

MultiRouter (class)

MultiRouter

ChanAssistList (class)

ChanAssistList

Class keeping a list of ChanAssist objects. It also serves as base to implement channel assisting plugins.

ChanAssist (class)

ChanAssist

Object that assists a channel

RTPGroup (class)

RTPGroup

Several possibly related RTP processors share the same RTP group which holds the thread that keeps them running.

RTPTransport (class)

RTPTransport

Class that holds sockets and addresses for transporting RTP and RTCP packets.

RTPSession (class)

RTPSession

An unidirectional or bidirectional RTP session

RTPSender (class)

RTPSender

Class that builds and sends RTP and RTCP packets

RTPReceiver (class)

RTPReceiver

Class that handles incoming RTP and RTCP packets

RTPSecure (class)

RTPSecure

Security and integrity implementation

RTPProcessor (class)

RTPProcessor

A base class that contains just placeholders to process raw RTP and RTCP packets.

RTPDejitter (class)

RTPDejitter

A dejitter buffer that can be inserted in the receive data path to absorb variations in packet arrival time. Incoming packets are stored and forwarded at fixed intervals.

RTPBaseIO (class)

RTPBaseIO

Base class that holds common sender and receiver methods

UDPSession (class)

UDPSession

A base class for RTP, SRTP or UDPTL sessions

UDPTLSession (class)

UDPTLSession

A bidirectional UDPTL session usable for T.38

ExpEvaluator (class)

ExpEvaluator

A class used to build stack based (posifix) expression parsers and evaluators

ExpOperation (class)

ExpOperation

This class describes a single operation in an expression evaluator

ExpExtender (class)

ExpExtender

This class allows extending ExpEvaluator to implement custom fields and functions

ParsePoint (class)

ParsePoint

A class used to keep a parsing context

ExpFunction (class)

ExpFunction

Small helper class that simplifies declaring native functions

ExpWrapper (class)

ExpWrapper

Helper class that allows wrapping entire objects in an operation

TableEvaluator (class)

TableEvaluator

An evaluator for multi-row (tables like in SQL) expressions

ScriptRun (class)

ScriptRun

An instance of script code and data, status machine run by a single thread at a time

ScriptContext (class)

ScriptContext

A script execution context, holds global variables and objects

ScriptCode (class)

ScriptCode

Preparsed script code fragment ready to be executed

ScriptStack (class)

ScriptStack

A stack for a script running instance

ScriptAsync (class)

ScriptAsync

Operation that is to be executed by the script runtime before current operation

ScriptParser (class)

ScriptParser

Abstract parser, base class for each language parser

JsFunction (class)

JsFunction

Javascript Function class, implements user defined functions

JsObject (class)

JsObject

Javascript Object class, base for all JS objects

JsArray (class)

JsArray

Javascript Array class, implements arrays of items

JsRegExp (class)

JsRegExp

Javascript RegExp class, implements regular expression matching

JsParser (class)

JsParser

Javascript parser, takes source code and generates preparsed code

SDPMedia (class)

SDPMedia

This class holds a single SDP media description

SDPSession (class)

SDPSession

This class holds RTP/SDP data for multiple media types NOTE: The SDPParser pointer held by this class is assumed to be non NULL

SDPParser (class)

SDPParser

This class holds a SDP parser and additional data used by SDP objects

SignallingDumper (class)

SignallingDumper

This class is a generic data dumper with libpcap compatibility

SignallingDumpable (class)

SignallingDumpable

A generic base class for components capable of creating data dumps

SignallingNotifier (class)

SignallingNotifier

Notifying class. Used to handle notifications.

SignallingTimer (class)

SignallingTimer

Timer management class. Used to manage timeouts. The time is kept in miliseconds

SignallingCounter (class)

SignallingCounter

Counter management class. Keep a value between 0 and a given maximum one

SignallingFactory (class)

SignallingFactory

A factory that constructs various elements by name

SignallingComponent (class)

SignallingComponent

Interface to an abstract signalling component that is managed by an engine. The engine will periodically poll each component to keep them alive.

SignallingEngine (class)

SignallingEngine

The engine is the center of all SS7 or ISDN applications. It is used as a base to build the protocol stack from components.

SignallingMessage (class)

SignallingMessage

Interface of protocol independent signalling message

SignallingCallControl (class)

SignallingCallControl

Interface of protocol independent signalling for phone calls

SignallingCall (class)

SignallingCall

Interface of protocol independent phone call

SignallingEvent (class)

SignallingEvent

An object holding a signalling event and related references

SignallingCircuitEvent (class)

SignallingCircuitEvent

An object holding a signalling circuit event and related references

SignallingCircuit (class)

SignallingCircuit

Interface to an abstract voice/data circuit referenced by signalling

SignallingCircuitRange (class)

SignallingCircuitRange

Keeps a range (set) of circuits. The circuit codes contained within a range may not be contiguous. See SignallingUtils::parseUIntArray() for the format of the string ranges this object can be built from

SignallingCircuitGroup (class)

SignallingCircuitGroup

Interface to a stateful group of voice/data circuits

SignallingCircuitSpan (class)

SignallingCircuitSpan

An interface to a span belonging to a circuit group

SignallingInterface (class)

SignallingInterface

An interface to an abstraction of a Layer 1 (hardware HDLC) interface

SignallingReceiver (class)

SignallingReceiver

An interface to an abstraction of a Layer 2 packet data receiver

SignallingFlags (struct)

SignallingFlags

This class keeps a description of a parameter flag used to encode/decode flags

SignallingUtils (class)

SignallingUtils

Provides data and services for SS7 and ISDN

SignallingMessageTimer (class)

SignallingMessageTimer

This class holds a signalling message along with timeout value(s)

SignallingMessageTimerList (class)

SignallingMessageTimerList

This class holds pending signalling messages. The list will keep objects in timeout ascending order

AnalogLine (class)

AnalogLine

This class is used to manage an analog line and keep data associated with it. Also it can be used to monitor a pair of FXS/FXO analog lines

AnalogLineEvent (class)

AnalogLineEvent

An object holding an event generated by an analog line and related references

AnalogLineGroup (class)

AnalogLineGroup

This class is an analog line container. It may contain another group when used to monitor analog lines

SS7PointCode (class)

SS7PointCode

An universal SS7 Layer 3 routing Code Point

SS7Label (class)

SS7Label

A SS7 Layer 3 routing label, both ANSI and ITU capable

SS7MSU (class)

SS7MSU

A raw data block with a little more understanding about MSU format

SIGTRAN (class)

SIGTRAN

An interface to a Signalling Transport user adaptation component

SIGTransport (class)

SIGTransport

A an abstraction offering connectivity to a SIGTRAN transport

SIGAdaptation (class)

SIGAdaptation

An interface to a Signalling Transport User Adaptation component

SIGAdaptClient (class)

SIGAdaptClient

Generic client side (ASP) Signalling Transport User Adaptation component

SIGAdaptServer (class)

SIGAdaptServer

Generic server side (SG) Signalling Transport User Adaptation component

SIGAdaptUser (class)

SIGAdaptUser

An interface to a Signalling Transport Adaptation user

ASPUser (class)

ASPUser

An interface to a SS7 Application Signalling Part user

SCCP (class)

SCCP

An interface to a SS7 Signalling Connection Control Part

GTT (class)

GTT

An interface to a SS7 SCCP Global Title Translation

SCCPManagement (class)

SCCPManagement

An interface to a SS7 SCCP Management

SCCPUser (class)

SCCPUser

An interface to a SS7 Signalling Connection Control Part user

TCAPUser (class)

TCAPUser

An interface to a SS7 Transactional Capabilities Application Part user

SS7L2User (class)

SS7L2User

An user of a Layer 2 (data link) SS7 message transfer part

SS7Layer2 (class)

SS7Layer2

An interface to a Layer 2 (data link) SS7 message transfer part

SS7L3User (class)

SS7L3User

An user of a Layer 3 (data link) SS7 message transfer part

SS7Layer3 (class)

SS7Layer3

An interface to a Layer 3 (network) SS7 message transfer part

SS7Layer4 (class)

SS7Layer4

An interface to a Layer 4 (application) SS7 protocol

SS7Route (class)

SS7Route

Keeps a packed destination point code, a network priority or a list of networks used to route to the enclosed destination point code

SS7Router (class)

SS7Router

A message router between Transfer and Application layers. Messages are distributed according to the service type.

SS7M2PA (class)

SS7M2PA

RFC4165 SS7 Layer 2 implementation over SCTP/IP. M2PA is intended to be used as a symmetrical Peer-to-Peer replacement of a hardware based SS7 data link.

SS7M2UA (class)

SS7M2UA

RFC3331 SS7 Layer 2 implementation over SCTP/IP. M2UA is intended to be used as a Provider-User where real MTP2 runs on a Signalling Gateway and MTP3 runs on an Application Server.

SS7M3UA (class)

SS7M3UA

RFC3332 SS7 Layer 3 implementation over SCTP/IP. M3UA is intended to be used as a Provider-User where real MTP3 runs on a Signalling Gateway and MTP users are located on an Application Server.

SS7MTP2 (class)

SS7MTP2

Q.703 SS7 Layer 2 (Data Link) implementation on top of a hardware interface

SS7MTP3 (class)

SS7MTP3

Q.704 SS7 Layer 3 (Network) implementation on top of SS7 Layer 2

SS7MsgSNM (class)

SS7MsgSNM

Decoded Signalling Network Management (SNM) User Part message

SS7MsgMTN (class)

SS7MsgMTN

Decoded Maintenance (MTN) User Part message

SS7MsgISUP (class)

SS7MsgISUP

Decoded ISDN User Part message

SS7MsgSCCP (class)

SS7MsgSCCP

SS7Management (class)

SS7Management

Implementation of SS7 SNM User Part (Management) - Q.704

SS7ISUPCall (class)

SS7ISUPCall

A signalling call using SS7 ISUP protocol

SS7ISUP (class)

SS7ISUP

Implementation of SS7 ISDN User Part

SS7BICC (class)

SS7BICC

Implementation of SS7 Bearer Independent Call Control User Part

SS7TUP (class)

SS7TUP

Implementation of SS7 Telephone User Part

SS7SCCP (class)

SS7SCCP

Implementation of SS7 Signalling Connection Control Part

SccpSubsystem (class)

SccpSubsystem

SccpLocalSubsystem (class)

SccpLocalSubsystem

SccpRemote (class)

SccpRemote

Helper class to keep a remote sccp

SS7AnsiSccpManagement (class)

SS7AnsiSccpManagement

SS7ItuSccpManagement (class)

SS7ItuSccpManagement

SS7SUA (class)

SS7SUA

RFC3868 SS7 SCCP implementation over SCTP/IP SUA is intended to be used as a Provider-User where real SCCP runs on a Signalling Gateway and SCCP users are located on an Application Server.

SS7TCAPMessage (class)

SS7TCAPMessage

A TCAP message wrapper, encapsulates the data received from SCCP

SS7TCAPError (class)

SS7TCAPError

SS7TCAP (class)

SS7TCAP

Implementation of SS7 Transactional Capabilities Application Part

SS7TCAPTransaction (class)

SS7TCAPTransaction

Implementation of SS7 Transactional Capabilities Application Part Transaction

SS7TCAPComponent (class)

SS7TCAPComponent

Implementation of SS7 Transactional Capabilities Application Part Component

SS7TCAPANSI (class)

SS7TCAPANSI

Implementation of SS7 Transactional Capabilities Application Part - specification ANSI

SS7TCAPTransactionANSI (class)

SS7TCAPTransactionANSI

Implementation of SS7 Transactional Capabilities Application Part Transaction - specification ANSI

SS7TCAPITU (class)

SS7TCAPITU

Implementation of SS7 Transactional Capabilities Application Part - specification ITU-T

SS7TCAPTransactionITU (class)

SS7TCAPTransactionITU

Implementation of SS7 Transactional Capabilities Application Part Transaction - specification ITU-T

ISDNLayer2 (class)

ISDNLayer2

An interface to a Layer 2 (Q.921) ISDN message transport

ISDNLayer3 (class)

ISDNLayer3

An interface to a Layer 3 (Q.931) ISDN message transport

ISDNFrame (class)

ISDNFrame

Encapsulates an ISDN (Q.921) frame exchanged over a hardware HDLC interface

ISDNQ921 (class)

ISDNQ921

Q.921 ISDN Layer 2 implementation on top of a hardware HDLC interface

ISDNQ921Passive (class)

ISDNQ921Passive

Q.921 ISDN Layer 2 pasive (stateless) implementation on top of a hardware HDLC interface

ISDNQ921Management (class)

ISDNQ921Management

This class is intended to be used as a proxy between an ISDN Layer 3 and multiple Layer 2 objects sharing the same signalling interface. It is used for BRI TEI management or PRI with D-channel backup. It also keeps a list of ISDN Layer 2 object(s) used for the designated purpose

ISDNIUA (class)

ISDNIUA

RFC4233 ISDN Layer 2 implementation over SCTP/IP IUA is intended to be used as a Provider-User where Q.921 runs on a Signalling Gateway and the user (Q.931) runs on an Application Server.

ISDNQ931IE (class)

ISDNQ931IE

Q.931 ISDN Layer 3 message Information Element

ISDNQ931Message (class)

ISDNQ931Message

Q.931 ISDN Layer 3 message

ISDNQ931IEData (class)

ISDNQ931IEData

Extract data from IEs. Append IEs to Q.931 messages

ISDNQ931State (class)

ISDNQ931State

Q.931 ISDN call and call controller state

ISDNQ931Call (class)

ISDNQ931Call

Q.931 ISDN call

ISDNQ931CallMonitor (class)

ISDNQ931CallMonitor

Q.931 ISDN call monitor

ISDNQ931ParserData (class)

ISDNQ931ParserData

This class holds Q.931 parser settings used to encode/decode Q.931 messages

ISDNQ931 (class)

ISDNQ931

Q.931 ISDN Layer 3 implementation on top of a Layer 2

ISDNQ931Monitor (class)

ISDNQ931Monitor

Q.931 ISDN Layer 3 implementation on top of a Layer 2. Manage Q.931 monitors

String&  operator<< (String& str, const SS7PointCode& cp)

operator<<

Operator to write a point code to a string

Parameters:
strString to append to
cpPoint code to append to the string

String&  operator<< (String& str, const SS7Label& label)

operator<<

Operator to write a routing label to a string

Parameters:
strString to append to
labelLabel to append to the string

HandledMSU (class)

HandledMSU

Simple inline class used to know if a MSU was handled and if not why

SubsystemStatusTest (class)

SubsystemStatusTest

SS7M2UAClient (class)

SS7M2UAClient

The common client side of SIGTRAN SS7 MTP2 User Adaptation (RFC3331)

SS7Testing (class)

SS7Testing

Implementation of SS7 MTP Test User Part - Q.782 2.3

SS7MsgSccpReassemble (class)

SS7MsgSccpReassemble

RemoteBackupSubsystem (class)

RemoteBackupSubsystem

SS7SCCPDataSegment (class)

SS7SCCPDataSegment

Helper class to memorize SCCP data segments

ISDNIUAClient (class)

ISDNIUAClient

The common client side of SIGTRAN ISDN Q.921 User Adaptation (RFC4233)

const char*  uncompactForm (const char* header)

uncompactForm

const char*  compactForm (const char* header)

compactForm

extern TokenDict* SIPResponses

SIPResponses

SIPEngine (class)

SIPEngine

The SIP engine holds common methods and the list of current transactions

SIPEvent (class)

SIPEvent

This object is an event that will be taken from SIPEngine

SIPParty (class)

SIPParty

SIPSequence (class)

SIPSequence

Command Sequence Number generator

SIPMessage (class)

SIPMessage

An object that holds the sip message parsed into this library model. This class can be used to parse a sip message from a text buffer, or it can be used to create a text buffer from a sip message.

SIPDialog (class)

SIPDialog

A class to store information required to identify a dialog

SIPTransaction (class)

SIPTransaction

All informaton related to a SIP transaction, starting with 1st message


Generated by: paulc on bussard on Thu Jul 24 18:41:02 2014, using kdoc 2.0a54.