|
|
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.
| void setDebugTimestamp ()
| setDebugTimestamp |
Enable timestamping of output messages and set the time start reference
| enum DebugLevel { DebugFail = 0, DebugGoOn = 2, DebugWarn = 5, DebugMild = 7, 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 debug level
Returns: The current debug level
| int debugLevel (int level)
| debugLevel |
Set the current debug level.
Parameters:
| level | The desired debug level |
Returns: The new debug level (may be different)
| bool debugAt (int level)
| debugAt |
Check if debugging output should be generated
Parameters:
| level | The desired debug level |
Returns: True if messages should be output, false otherwise
| bool 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.
| bool 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.
| bool 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.
| bool 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.
| bool 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).
| bool 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).
| bool Debug (int level, const char *format, ...)
| Debug |
Outputs a debug string.
Parameters:
| level | The level of the message |
| format | A printf() style format string |
Returns: True if message was output, false otherwise
| bool 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 |
Returns: True if message was output, false otherwise
| void Output (const char *format, ...)
| Output |
Outputs a string to the debug console with formatting
Parameters:
| facility | Facility that outputs the message |
| 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)
| 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.
| 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.
| ObjList (class) | ObjList |
A simple single-linked object list handling class
| 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
| 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 char * strcpy (String &dest, const char *src)
| strcpy |
Prevent careless programmers from overwriting the string
See also: operator=
| inline 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
| Time (class) | Time |
The Time class holds a time moment with microsecond accuracy
| MD5 (class) | MD5 |
A class to compute and check MD5 digests
| NamedList (class) | NamedList |
This class holds a named list of named strings
| 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
| 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
| 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.
| 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); |
| Engine (class) | Engine |
This class holds global information about the engine. Note: this is a singleton class.
| FormatInfo (struct) | FormatInfo |
A structure to hold information about a data format.
| 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
| DataBlock (class) | DataBlock |
The DataBlock holds a data buffer with no specific formatting.
| DataNode (class) | DataNode |
A generic data handling object
| DataConsumer (class) | DataConsumer |
A data consumer
| DataSource (class) | DataSource |
A data source
| 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
| 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
| Generated by: kk on nyx on Sat Jun 4 19:29:41 2005, using kdoc 2.0a54. |