|
Yate
|
Classes | |
| class | Array |
| A list based Array. More... | |
| class | Atom |
| Atom string holder. More... | |
| class | Base64 |
| Base64 encoder/decoder class. More... | |
| class | BitVector |
| A slice vector holding bits. More... | |
| class | CallAccount |
| Settings for an account handling calls. More... | |
| class | CallEndpoint |
| An abstract call endpoint. More... | |
| class | CapturedEvent |
| A captured event string with a debug level. More... | |
| class | Channel |
| An abstract communication channel. More... | |
| class | Cipher |
| An abstract cipher. More... | |
| class | Client |
| Class that runs the User Interface. More... | |
| class | ClientAccount |
| An account. More... | |
| class | ClientAccountList |
| A client account list. More... | |
| class | ClientChannel |
| Channel used by client programs. More... | |
| class | ClientContact |
| A client contact. More... | |
| class | ClientDir |
| A directory. More... | |
| class | ClientDriver |
| Base Driver with client specific functions. More... | |
| class | ClientFile |
| A file. More... | |
| class | ClientFileItem |
| A file/directory item. More... | |
| class | ClientLogic |
| Base class for all client logics. More... | |
| class | ClientResource |
| A client contact's resource. More... | |
| class | ClientSound |
| A sound file. More... | |
| class | Complex |
| A Complex (float) number. More... | |
| class | Compressor |
| An abstract data (de)compressor. More... | |
| class | Configuration |
| Configuration file handling. More... | |
| class | DataBlock |
| A class that holds just a block of raw data. More... | |
| class | DataConsumer |
| class | DataEndpoint |
| A data transfer endpoint capable of sending and/or receiving data. More... | |
| class | DataFormat |
| A Data format. More... | |
| class | DataNode |
| class | DataSource |
| class | DataTranslator |
| An unidirectional data translator (codec) More... | |
| class | DebugEnabler |
| A holder for a debug level. More... | |
| class | Debugger |
| An object that logs messages on creation and destruction. More... | |
| class | DefaultLogic |
| The client's default logic. More... | |
| class | DnsRecord |
| A DNS record. More... | |
| class | Driver |
| A Channel driver module. More... | |
| class | DurationUpdate |
| An UI time updater. More... | |
| class | Engine |
| Engine globals. More... | |
| class | EngineCheck |
| Engine checker interface. More... | |
| class | File |
| A stream file class. More... | |
| class | Flags32 |
| A 32 bit length list of flags. More... | |
| struct | FormatInfo |
| class | FormatRepository |
| A repository for media formats. More... | |
| class | GenObject |
| class | GenPointer |
| Templated pointer that can be inserted in a list. More... | |
| class | Hasher |
| An abstract hashing class. More... | |
| class | HashList |
| A hashed object list class. More... | |
| struct | ImageInfo |
| class | ListIterator |
| Class used to iterate the items of a list. More... | |
| class | Lock |
| Ephemeral mutex or semaphore locking object. More... | |
| class | Lock2 |
| Ephemeral double mutex locking object. More... | |
| class | Lockable |
| Abstract interface for lockable objects. More... | |
| class | Math |
| Math utilities. More... | |
| class | MathVectorBase |
| Base class for vector class(es) More... | |
| class | MD5 |
| A standard MD5 digest calculator. More... | |
| class | MemoryStream |
| A Stream that operates on DataBlocks in memory. More... | |
| class | Message |
| A message container class. More... | |
| class | MessageDispatcher |
| A message dispatching hub. More... | |
| class | MessageHandler |
| A message handler. More... | |
| class | MessageHook |
| Abstract message hook. More... | |
| class | MessageNotifier |
| Post-dispatching message hook. More... | |
| class | MessagePostHook |
| Post-dispatching message hook that can be added to a list. More... | |
| class | MessageQueue |
| A message queue. More... | |
| class | MessageReceiver |
| A multiple message receiver. More... | |
| class | MessageRelay |
| A message handler relay. More... | |
| class | MimeAuthLine |
| MIME authentication line. More... | |
| class | MimeBinaryBody |
| MIME for obscure binary data. More... | |
| class | MimeBody |
| Abstract MIME data holder. More... | |
| class | MimeHeaderLine |
| MIME header line. More... | |
| class | MimeLinesBody |
| MIME for multiple text lines. More... | |
| class | MimeMultipartBody |
| MIME multipart container. More... | |
| class | MimeSdpBody |
| MIME for application/sdp. More... | |
| class | MimeStringBody |
| MIME for one text string. More... | |
| class | Module |
| A Plugin that implements a module. More... | |
| class | MucRoom |
| An account's MUC room contact. More... | |
| class | MucRoomMember |
| A MUC room member. More... | |
| class | Mutex |
| Mutex support. More... | |
| class | MutexPool |
| A Mutex pool. More... | |
| class | NamedCounter |
| Atomic counter with name. More... | |
| class | NamedInt |
| A named integer value. More... | |
| class | NamedIterator |
| NamedList parameters iterator. More... | |
| class | NamedList |
| A named string container class. More... | |
| class | NamedPointer |
| A named pointer class. More... | |
| class | NamedString |
| A named string class. More... | |
| class | NaptrRecord |
| A NAPTR record. More... | |
| class | ObjList |
| An object list class. More... | |
| class | ObjVector |
| A vector holding GenObjects. More... | |
| class | Plugin |
| Plugin support. More... | |
| class | Random |
| Pseudo random number generator. More... | |
| class | RefObject |
| class | RefPointer |
| Templated smart pointer class. More... | |
| class | RefPointerBase |
| Internal helper class. More... | |
| class | RefStorage |
| A fixed ref counted storage. More... | |
| class | Regexp |
| A regexp matching class. More... | |
| class | Resolver |
| DNS services. More... | |
| class | Router |
| Call routing thread. More... | |
| class | Runnable |
| Encapsulates a runnable task. More... | |
| class | SctpSocket |
| Abstract SCTP Socket. More... | |
| class | Semaphore |
| Semaphore implementation. More... | |
| class | SHA1 |
| A standard SHA1 digest calculator. More... | |
| class | SHA256 |
| A standard SHA256 digest calculator. More... | |
| class | SharedVars |
| Atomic access and operations to shared variables. More... | |
| class | SliceVector |
| A slice vector. More... | |
| class | Socket |
| A generic socket class. More... | |
| class | SocketAddr |
| A socket address holder. More... | |
| class | SocketFilter |
| A filter for received socket data. More... | |
| class | SrvRecord |
| A SRV record. More... | |
| class | Stream |
| An abstract stream class capable of reading and writing. More... | |
| class | String |
| A C-style string handling class. More... | |
| class | SysUsage |
| A class exposing system resources usage. More... | |
| class | TempObjectCounter |
| Ephemeral object counter changer. More... | |
| class | Thread |
| Thread support class. More... | |
| class | ThreadedSource |
| Data source with own thread. More... | |
| class | Time |
| A time holding class. More... | |
| struct | TokenDict |
| struct | TranslatorCaps |
| class | TranslatorFactory |
| An unidirectional data translator (codec) More... | |
| class | TxtRecord |
| A text based DNS record. More... | |
| class | UChar |
| A single Unicode character. More... | |
| class | UIFactory |
| A static user interface creator. More... | |
| class | UIWidget |
| class | URI |
| Encapsulation for an URI. More... | |
| class | Window |
| An abstract user interface window. More... | |
| class | XmlCData |
| Xml Declaration. More... | |
| class | XmlChild |
| Xml Child. More... | |
| class | XmlComment |
| Xml Comment. More... | |
| class | XmlDeclaration |
| Xml Declaration. More... | |
| class | XmlDoctype |
| class | XmlDocument |
| Xml Document. More... | |
| class | XmlDomParser |
| Document Object Model XML Parser. More... | |
| class | XmlElement |
| Xml Element. More... | |
| struct | XmlEscape |
| class | XmlFragment |
| Xml Fragment. More... | |
| class | XmlParent |
| Xml Parent. More... | |
| class | XmlSaxParser |
| Serial Access XML Parser. More... | |
| class | XmlText |
| Xml Declaration. More... | |
Typedefs | |
| typedef int(* | EngineLoop )() |
| typedef SliceVector< Complex > | ComplexVector |
| typedef SliceVector< float > | FloatVector |
| typedef SliceVector< uint8_t > | ByteVector |
Enumerations | |
| enum | DebugLevel { DebugFail = 0, DebugTest = 1, DebugCrit = 2, DebugGoOn = DebugCrit, DebugConf = 3, DebugStub = 4, DebugWarn = 5, DebugMild = 6, DebugNote = 7, DebugCall = 8, DebugInfo = 9, DebugAll = 10 } |
Functions | |
| void | abortOnBug () |
| bool | abortOnBug (bool doAbort) |
| int | debugLevel () |
| int | debugLevel (int level) |
| bool | debugAt (int level) |
| const char * | debugColor (int level) |
| const char * | debugLevelName (int level) |
| void | DDebug (int level, const char *format,...) |
| void | DDebug (const char *facility, int level, const char *format,...) |
| void | DDebug (const DebugEnabler *local, int level, const char *format,...) |
| void | XDebug (int level, const char *format,...) |
| void | XDebug (const char *facility, int level, const char *format,...) |
| void | XDebug (const DebugEnabler *local, int level, const char *format,...) |
| void | NDebug (int level, const char *format,...) |
| void | NDebug (const char *facility, int level, const char *format,...) |
| void | NDebug (const DebugEnabler *local, int level, const char *format,...) |
| void | Debug (int level, const char *format,...) |
| void | Debug (const char *facility, int level, const char *format,...) |
| void | Debug (const DebugEnabler *local, int level, const char *format,...) |
| void | Alarm (const char *component, int level, const char *format,...) |
| void | Alarm (const DebugEnabler *component, int level, const char *format,...) |
| void | Alarm (const char *component, const char *info, int level, const char *format,...) |
| void | Alarm (const DebugEnabler *component, const char *info, int level, const char *format,...) |
| void | Output (const char *format,...) |
| void | YIGNORE (primitive value) |
| constant | YSTRING (const char *string) |
| constant | YATOM (const char *string) |
| void | YCLASS (class type, class base) |
| void | YCLASS2 (class type, class base1, class base2) |
| void | YCLASS3 (class type, class base1, class base2, class base3) |
| void | YCLASSIMP (class type, class base) |
| void | YCLASSIMP2 (class type, class base1, class base2) |
| void | YCLASSIMP3 (class type, class base1, class base2, class base3) |
| class * | YOBJECT (class type, GenObject *pntr) |
| void | YNOCOPY (class type) |
| void | destruct (GenObject *obj) |
| template<class Obj > | |
| void | destruct (Obj *&obj) |
| const char * | c_str (const String *str) |
| const char * | c_safe (const char *str) |
| const char * | c_safe (const String *str) |
| bool | null (const char *str) |
| bool | null (const String *str) |
| String | operator+ (const String &s1, const String &s2) |
| String | operator+ (const String &s1, const char *s2) |
| String | operator+ (const char *s1, const String &s2) |
| const char * | strcpy (String &dest, const char *src) |
| const char * | strcat (String &dest, const char *src) |
| int | lookup (const char *str, const TokenDict *tokens, int defvalue=0, int base=0) |
| const char * | lookup (int value, const TokenDict *tokens, const char *defvalue=0) |
| bool | controlReturn (NamedList *params, bool ret, const char *retVal=0) |
| void | INIT_PLUGIN (class pclass) |
| bool | UNLOAD_PLUGIN (bool unloadNow) |
| bool | isE164 (const char *str) |
| Complex | operator+ (const Complex &c1, const Complex &c2) |
| Complex | operator+ (const Complex &c, float f) |
| Complex | operator+ (float f, const Complex &c) |
| Complex | operator- (const Complex &c1, const Complex &c2) |
| Complex | operator- (const Complex &c, float f) |
| Complex | operator* (const Complex &c1, const Complex &c2) |
| Complex | operator* (const Complex &c, float f) |
| Complex | operator* (float f, const Complex &c) |
| Complex | operator/ (const Complex &c1, const Complex &c2) |
| Complex | operator/ (const Complex &c, float f) |
| String & | operator<< (String &str, const Complex &c) |
| String & | operator<< (String &str, const BitVector &b) |
Holds all Telephony Engine related classes.
| typedef int(* EngineLoop)() |
Prototype for engine main loop callback
| enum DebugLevel |
Standard debugging levels. The DebugFail level is special - it is always displayed and may abort the program if abortOnBug() is set.
| void TelEngine::abortOnBug | ( | ) |
Abort execution (and coredump if allowed) if the abort flag is set. This function may not return.
| bool TelEngine::abortOnBug | ( | bool | doAbort | ) |
Set the abort on bug flag. The default flag state is false.
| void TelEngine::Alarm | ( | const char * | component, |
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Outputs a debug string and emits an alarm if a callback is installed
| component | Component that emits the alarm |
| level | The level of the alarm |
| format | A printf() style format string |
| void TelEngine::Alarm | ( | const DebugEnabler * | component, |
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Outputs a debug string and emits an alarm if a callback is installed
| component | Pointer to a DebugEnabler holding component name and debugging settings |
| level | The level of the alarm |
| format | A printf() style format string |
| void TelEngine::Alarm | ( | const char * | component, |
| const char * | info, | ||
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Outputs a debug string and emits an alarm if a callback is installed
| component | Component that emits the alarm |
| info | Extra alarm information |
| level | The level of the alarm |
| format | A printf() style format string |
| void TelEngine::Alarm | ( | const DebugEnabler * | component, |
| const char * | info, | ||
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Outputs a debug string and emits an alarm if a callback is installed
| component | Pointer to a DebugEnabler holding component name and debugging settings |
| info | Extra alarm information |
| level | The level of the alarm |
| format | A printf() style format string |
|
inline |
Utility function to replace NULL C string pointers with an empty C string
| str | Pointer to a C string that may be NULL |
|
inline |
Utility function to replace NULL String pointers with an empty C string
| str | Pointer to a String that may be NULL |
References String::safe().
|
inline |
Utility function to retrieve a C string from a possibly NULL String pointer
| str | Pointer to a String that may be NULL |
References String::c_str().
| bool TelEngine::controlReturn | ( | NamedList * | params, |
| bool | ret, | ||
| const char * | retVal = 0 |
||
| ) |
Utility method to return from a chan.control handler
| params | The parameters list |
| ret | The return value |
| retVal | The error message |
| void TelEngine::DDebug | ( | int | level, |
| const char * | format, | ||
| ... | |||
| ) |
Convenience macro. Does the same as Debug if DEBUG is #defined (compiling for debugging) else it does not get compiled at all.
| void TelEngine::DDebug | ( | const char * | facility, |
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Convenience macro. Does the same as Debug if DEBUG is #defined (compiling for debugging) else it does not get compiled at all.
| void TelEngine::DDebug | ( | const DebugEnabler * | local, |
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Convenience macro. Does the same as Debug if DEBUG is #defined (compiling for debugging) else it does not get compiled at all.
| void TelEngine::Debug | ( | int | level, |
| const char * | format, | ||
| ... | |||
| ) |
Outputs a debug string.
| level | The level of the message |
| format | A printf() style format string |
| void TelEngine::Debug | ( | const char * | facility, |
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Outputs a debug string for a specific facility.
| facility | Facility that outputs the message |
| level | The level of the message |
| format | A printf() style format string |
| void TelEngine::Debug | ( | const DebugEnabler * | local, |
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Outputs a debug string for a specific facility.
| local | Pointer to a DebugEnabler holding current debugging settings |
| level | The level of the message |
| format | A printf() style format string |
| bool TelEngine::debugAt | ( | int | level | ) |
Check if debugging output should be generated
| level | The global debug level we are testing |
| const char* TelEngine::debugColor | ( | int | level | ) |
Get an ANSI string to colorize debugging output
| level | The debug level who's color is requested. Negative or out of range will reset to the default color |
| int TelEngine::debugLevel | ( | ) |
Retrieve the current global debug level
| int TelEngine::debugLevel | ( | int | level | ) |
Set the current global debug level.
| level | The desired debug level |
| const char* TelEngine::debugLevelName | ( | int | level | ) |
Get the name of a debugging or alarm level
| level | The debug level |
|
inline |
Helper function that destroys a GenObject only if the pointer is non-NULL. Use it instead of the delete operator.
| obj | Pointer (rvalue) to the object to destroy |
References GenObject::destruct().
Referenced by XmlParent::addChildSafe(), and ClientChannel::setClientData().
| void TelEngine::destruct | ( | Obj *& | obj | ) |
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.
| obj | Reference to pointer (lvalue) to the object to destroy |
| void TelEngine::INIT_PLUGIN | ( | class pclass | ) |
Macro to create static instance of the plugin
| pclass | Class of the plugin to create |
| bool TelEngine::isE164 | ( | const char * | str | ) |
Find if a string appears to be an E164 phone number
| str | String to check |
| int TelEngine::lookup | ( | const char * | str, |
| const TokenDict * | tokens, | ||
| int | defvalue = 0, |
||
| int | base = 0 |
||
| ) |
Utility function to look up a string in a token table, interpret as number if it fails
| 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 |
Referenced by Cipher::direction(), XmlSaxParser::getError(), ClientChannel::lookup(), SocketAddr::lookupFamily(), ClientChannel::lookupSlaveType(), Module::relayId(), Socket::setTOS(), ClientResource::statusDisplayText(), and ClientResource::statusName().
| const char* TelEngine::lookup | ( | int | value, |
| const TokenDict * | tokens, | ||
| const char * | defvalue = 0 |
||
| ) |
Utility function to look up a number in a token table
| value | Value to search for |
| tokens | Pointer to the token table |
| defvalue | Value to return if lookup fails |
| void TelEngine::NDebug | ( | int | level, |
| const char * | format, | ||
| ... | |||
| ) |
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 TelEngine::NDebug | ( | const char * | facility, |
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
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 TelEngine::NDebug | ( | const DebugEnabler * | local, |
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Convenience macro. Does the same as Debug if NDEBUG is not #defined else it does not get compiled at all (compiling for mature release).
|
inline |
Utility function to check if a C string is null or empty
| str | Pointer to a C string |
Referenced by SliceVector< Obj >::dump(), and XmlElement::setAttributeValid().
|
inline |
Utility function to check if a String is null or empty
| str | Pointer to a String |
References String::null().
|
inline |
Multiplication operator
| c1 | First number |
| c2 | Second number |
Referenced by operator*().
|
inline |
|
inline |
Multiplication operator
| f | A float value |
| c | A Complex number |
References operator*().
|
inline |
Addition operator
| c1 | First number |
| c2 | Second number |
|
inline |
|
inline |
Addition operator
| f | The float value |
| c | The Complex number |
References operator+().
| String TelEngine::operator+ | ( | const String & | s1, |
| const String & | s2 | ||
| ) |
Concatenation operator for strings.
Referenced by operator+().
| String TelEngine::operator+ | ( | const String & | s1, |
| const char * | s2 | ||
| ) |
Concatenation operator for strings.
| String TelEngine::operator+ | ( | const char * | s1, |
| const String & | s2 | ||
| ) |
Concatenation operator for strings.
|
inline |
Substraction operator
| c1 | First number |
| c2 | Second number |
|
inline |
|
inline |
Division operator
| c1 | First number |
| c2 | Second number |
|
inline |
|
inline |
Append operator: append a Complex number to a String
| str | Destination string |
| c | Complex number to append |
References Math::dumpComplex().
|
inline |
Append operator: append a BitVector to a String
| str | Destination string |
| b | Vector to append |
References BitVector::appendTo().
| void TelEngine::Output | ( | const char * | format, |
| ... | |||
| ) |
Outputs a string to the debug console with formatting
| format | A printf() style format string |
|
inline |
Prevent careless programmers from overwriting the string
References String::c_str().
|
inline |
Prevent careless programmers from overwriting the string
References String::c_str().
| bool TelEngine::UNLOAD_PLUGIN | ( | bool | unloadNow | ) |
Macro to create the unloading function
| unloadNow | True if asked to unload immediately, false if just checking |
| void TelEngine::XDebug | ( | int | level, |
| const char * | format, | ||
| ... | |||
| ) |
Convenience macro. Does the same as Debug if XDEBUG is #defined (compiling for extra debugging) else it does not get compiled at all.
| void TelEngine::XDebug | ( | const char * | facility, |
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Convenience macro. Does the same as Debug if XDEBUG is #defined (compiling for extra debugging) else it does not get compiled at all.
| void TelEngine::XDebug | ( | const DebugEnabler * | local, |
| int | level, | ||
| const char * | format, | ||
| ... | |||
| ) |
Convenience macro. Does the same as Debug if XDEBUG is #defined (compiling for extra debugging) else it does not get compiled at all.
| constant TelEngine::YATOM | ( | const char * | string | ) |
| void TelEngine::YCLASS | ( | class type | , |
| class base | |||
| ) |
Macro to create a GenObject class from a base class and implement GenObject::getObject
| type | Class that is declared |
| base | Base class that is inherited |
| void TelEngine::YCLASS2 | ( | class type | , |
| class base1 | , | ||
| class base2 | |||
| ) |
Macro to create a GenObject class from two base classes and implement GenObject::getObject
| type | Class that is declared |
| base1 | First base class that is inherited |
| base2 | Second base class that is inherited |
| void TelEngine::YCLASS3 | ( | class type | , |
| class base1 | , | ||
| class base2 | , | ||
| class base3 | |||
| ) |
Macro to create a GenObject class from three base classes and implement GenObject::getObject
| type | Class that is declared |
| base1 | First base class that is inherited |
| base2 | Second base class that is inherited |
| base3 | Third base class that is inherited |
| void TelEngine::YCLASSIMP | ( | class type | , |
| class base | |||
| ) |
Macro to implement GenObject::getObject in a derived class
| type | Class that is declared |
| base | Base class that is inherited |
| void TelEngine::YCLASSIMP2 | ( | class type | , |
| class base1 | , | ||
| class base2 | |||
| ) |
Macro to implement GenObject::getObject in a derived class
| type | Class that is declared |
| base1 | First base class that is inherited |
| base2 | Second base class that is inherited |
| void TelEngine::YCLASSIMP3 | ( | class type | , |
| class base1 | , | ||
| class base2 | , | ||
| class base3 | |||
| ) |
Macro to implement GenObject::getObject in a derived class
| type | Class that is declared |
| base1 | First base class that is inherited |
| base2 | Second base class that is inherited |
| base3 | Third base class that is inherited |
| void TelEngine::YIGNORE | ( | primitive | value | ) |
Macro to ignore the result of a function
| value | Returned value to be ignored, must be interpretable as boolean |
| void TelEngine::YNOCOPY | ( | class type | ) |
Macro to disable automatic copy and assignment operators
| type | Class that is declared |
| class* TelEngine::YOBJECT | ( | class type | , |
| GenObject * | pntr | ||
| ) |
Macro to retrieve a typed pointer to an interface from an object
| type | Class we want to return |
| pntr | Pointer to the object we want to get the interface from |
| constant TelEngine::YSTRING | ( | const char * | string | ) |
Macro to create a local static String if supported by compiler, use with caution
| string | Literal constant string |
Referenced by ClientLogic::cdrRemoteParty(), ClientAccount::dataDir(), ClientAccount::hasChat(), ClientAccount::hasPresence(), ClientContact::local(), ClientAccount::protocol(), ClientContact::remote(), and ClientAccount::startup().
1.8.8