|
|
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, DebugGoOn = 2, 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 |
Retrive the current global debug level
Returns: The current global debug level
int debugLevel (int level)
| debugLevel |
Set the current global debug level.
Parameters:
level | The 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:
level | The 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:
level | The 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
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:
level | The level of the message |
format | A printf() style format string |
void Debug (const char* facility, int level, const char* format, ...)
| Debug |
Outputs a debug string for a specific facility.
Parameters:
facility | Facility that outputs the message |
level | The level of the message |
format | A printf() style format string |
void Debug (const DebugEnabler* local, int level, const char* format, ...)
| Debug |
Outputs a debug string for a specific facility.
Parameters:
local | Pointer to a DebugEnabler holding current debugging settings |
level | The level of the message |
format | A printf() style format string |
void Output (const char* format, ...)
| Output |
Outputs a string to the debug console with formatting
Parameters:
format | A 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.
void YCLASS (class type,class base)
| YCLASS |
Macro to create a GenObject class from a base class and implement GenObject::getObject
Parameters:
type | Class that is declared |
base | Base class that is inherited |
class* YOBJECT (class type,GenObject* pntr)
| YOBJECT |
Macro to retrive a typed pointer to an interface from an object
Parameters:
type | Class we want to return |
pntr | Pointer to the object we want to get the interface from |
Returns: Pointer to the class we want or NULL
GenObject (class) | GenObject |
An object with just a public virtual destructor
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 |
ObjList (class) | ObjList |
A simple single-linked object list handling class
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.
inline const char * c_safe (const char* str)
| c_safe |
Utility function to replace NULL string pointers with an empty string
Parameters:
str | Pointer to a C string that may be NULL |
Returns: Original pointer or pointer to an empty string
inline bool null (const char* str)
| null |
Utility function to check if a C string is null or empty
Parameters:
str | Pointer to a C string |
Returns: True if str is NULL or starts with a NUL character
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:
str | String to look up |
tokens | Pointer to the token table |
defvalue | Value to return if lookup and conversion fail |
base | Default 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:
value | Value to search for |
tokens | Pointer to the token table |
defvalue | Value to return if lookup fails |
NamedString (class) | NamedString |
A string class with a hashed string name
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
DataBlock (class) | DataBlock |
The DataBlock holds a data buffer with no specific formatting.
MD5 (class) | MD5 |
A class to compute and check MD5 digests
SHA1 (class) | SHA1 |
A class to compute and check SHA1 digests
NamedList (class) | NamedList |
This class holds a named list of named strings
URI (class) | URI |
Uniform Resource Identifier encapsulation and parser. For efficiency reason the parsing is delayed as long as possible
Mutex (class) | Mutex |
A simple mutual exclusion for locking access between threads
Lock (class) | Lock |
A lock is a stack allocated (automatic) object that locks a mutex 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.
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
File (class) | File |
Class to encapsulate a system dependent file in a system independent abstraction
SysUsage (class) | SysUsage |
The SysUsage class allows collecting some statistics about engine's usage of system resources
Configuration (class) | Configuration |
A class for parsing and quickly accessing INI style configuration files
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.
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
MessageRelay (class) | MessageRelay |
A message handler that allows to relay several messages to a single receiver
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.
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:
pclass | Class of the plugin to create |
Engine (class) | Engine |
This class holds global information about the engine. Note: this is a singleton class.
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.
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
DataEndpoint (class) | DataEndpoint |
The DataEndpoint holds an endpoint capable of performing unidirectional or bidirectional data transfers
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:
str | String to check |
Returns: True if str appears to be a valid E164 number
Client (class) | Client |
Singleton class that holds the User Interface's main thread and 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
Window (class) | Window |
A window is the basic user interface element. Everything inside is implementation specific functionality.
UIFactory (class) | UIFactory |
Each instance of UIFactory creates special user interface elements by name
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
Generated by: root on dragoshel on Sat Apr 14 01:50:50 2007, using kdoc 2.0a54. |