/* * yateclass.h * This file is part of the YATE Project http://YATE.null.ro * * Base classes and types, not related to the engine or telephony * * Yet Another Telephony Engine - a fully featured software PBX and IVR * Copyright (C) 2004-2006 Null Team * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. */ #ifndef __YATECLASS_H #define __YATECLASS_H #ifndef __cplusplus #error C++ is required #endif #include #include #include #include #ifndef _WORDSIZE #if defined(__arch64__) || defined(__x86_64__) \ || defined(__amd64__) || defined(__ia64__) \ || defined(__alpha__) || defined(__sparcv9) #define _WORDSIZE 64 #else #define _WORDSIZE 32 #endif #endif #ifndef _WINDOWS #if defined(WIN32) || defined(_WIN32) #define _WINDOWS #endif #endif #ifdef _WINDOWS #include #include #include /** * Windows definitions for commonly used types */ typedef signed __int8 int8_t; typedef unsigned __int8 u_int8_t; typedef unsigned __int8 uint8_t; typedef signed __int16 int16_t; typedef unsigned __int16 u_int16_t; typedef unsigned __int16 uint16_t; typedef signed __int32 int32_t; typedef unsigned __int32 u_int32_t; typedef unsigned __int32 uint32_t; typedef signed __int64 int64_t; typedef unsigned __int64 u_int64_t; typedef unsigned __int64 uint64_t; typedef int pid_t; typedef int socklen_t; typedef unsigned long in_addr_t; #ifndef strcasecmp #define strcasecmp _stricmp #endif #ifndef strncasecmp #define strncasecmp _strnicmp #endif #define vsnprintf _vsnprintf #define snprintf _snprintf #define strdup _strdup #define open _open #define dup2 _dup2 #define read _read #define write _write #define close _close #define getpid _getpid #define chdir _chdir #define mkdir(p,m) _mkdir(p) #define unlink _unlink #define O_RDWR _O_RDWR #define O_RDONLY _O_RDONLY #define O_WRONLY _O_WRONLY #define O_APPEND _O_APPEND #define O_BINARY _O_BINARY #define O_EXCL _O_EXCL #define O_CREAT _O_CREAT #define O_TRUNC _O_TRUNC #define O_NOCTTY 0 #define S_IRUSR _S_IREAD #define S_IWUSR _S_IWRITE #define S_IXUSR 0 #define S_IRWXU (_S_IREAD|_S_IWRITE) #ifdef LIBYATE_EXPORTS #define YATE_API __declspec(dllexport) #else #ifndef LIBYATE_STATIC #define YATE_API __declspec(dllimport) #endif #endif #define FMT64 "%I64d" #define FMT64U "%I64u" #else /* _WINDOWS */ #include #include #if defined(__FreeBSD__) #include #endif #include #include #include #include #include /** * Non-Windows definitions for commonly used types */ #ifndef SOCKET typedef int SOCKET; #endif #ifndef HANDLE typedef int HANDLE; #endif #ifndef O_BINARY #define O_BINARY 0 #endif #if _WORDSIZE == 64 #define FMT64 "%ld" #define FMT64U "%lu" #else #define FMT64 "%lld" #define FMT64U "%llu" #endif #endif /* ! _WINDOWS */ #ifndef IPTOS_LOWDELAY #define IPTOS_LOWDELAY 0x10 #define IPTOS_THROUGHPUT 0x08 #define IPTOS_RELIABILITY 0x04 #define IPTOS_MINCOST 0x02 #endif #ifndef YATE_API #define YATE_API #endif #ifdef _WINDOWS #undef RAND_MAX #define RAND_MAX 2147483647 extern "C" { YATE_API long int random(); YATE_API void srandom(unsigned int seed); } #endif /** * Holds all Telephony Engine related classes. */ namespace TelEngine { #ifdef HAVE_GCC_FORMAT_CHECK #define FORMAT_CHECK(f) __attribute__((format(printf,(f),(f)+1))) #else #define FORMAT_CHECK(f) #endif /** * Abort execution (and coredump if allowed) if the abort flag is set. * This function may not return. */ YATE_API void abortOnBug(); /** * Set the abort on bug flag. The default flag state is false. * @return The old state of the flag. */ YATE_API bool abortOnBug(bool doAbort); /** * Standard debugging levels. * The DebugFail level is special - it is always displayed and may abort * the program if @ref abortOnBug() is set. */ enum DebugLevel { DebugFail = 0, DebugGoOn = 2, DebugStub = 4, DebugWarn = 5, DebugMild = 6, DebugCall = 7, DebugNote = 8, DebugInfo = 9, DebugAll = 10 }; /** * Retrive the current global debug level * @return The current global debug level */ YATE_API int debugLevel(); /** * Set the current global debug level. * @param level The desired debug level * @return The new global debug level (may be different) */ YATE_API int debugLevel(int level); /** * Check if debugging output should be generated * @param level The global debug level we are testing * @return True if messages should be output, false otherwise */ YATE_API bool debugAt(int level); /** * Get an ANSI string to colorize debugging output * @param level The debug level who's color is requested. * Negative or out of range will reset to the default color * @return ANSI string that sets color corresponding to level */ YATE_API const char* debugColor(int level); /** * Holds a local debugging level that can be modified separately from the * global debugging * @short A holder for a debug level */ class YATE_API DebugEnabler { public: /** * Constructor * @param level The initial local debug level * @param enabled Enable debugging on this object */ inline DebugEnabler(int level = TelEngine::debugLevel(), bool enabled = true) : m_level(DebugFail), m_enabled(enabled), m_chain(0), m_name(0) { debugLevel(level); } inline ~DebugEnabler() { m_name = 0; m_chain = 0; } /** * Retrive the current local debug level * @return The current local debug level */ inline int debugLevel() const { return m_chain ? m_chain->debugLevel() : m_level; } /** * Set the current local debug level. * @param level The desired debug level * @return The new debug level (may be different) */ int debugLevel(int level); /** * Retrive the current debug activation status * @return True if local debugging is enabled */ inline bool debugEnabled() const { return m_chain ? m_chain->debugEnabled() : m_enabled; } /** * Set the current debug activation status * @param enable The new debug activation status, true to enable */ inline void debugEnabled(bool enable) { m_enabled = enable; m_chain = 0; } /** * Get the current debug name * @return Name of the debug activation if set or NULL */ inline const char* debugName() const { return m_name; } /** * Check if debugging output should be generated * @param level The debug level we are testing * @return True if messages should be output, false otherwise */ bool debugAt(int level) const; /** * Check if this enabler is chained to another one * @return True if local debugging is chained to other enabler */ inline bool debugChained() const { return m_chain != 0; } /** * Chain this debug holder to a parent or detach from existing one * @param chain Pointer to parent debug level, NULL to detach */ inline void debugChain(const DebugEnabler* chain = 0) { m_chain = (chain != this) ? chain : 0; } /** * Copy debug settings from another object or from engine globals * @param original Pointer to a DebugEnabler to copy settings from */ void debugCopy(const DebugEnabler* original = 0); protected: /** * Set the current debug name * @param name Static debug name or NULL */ inline void debugName(const char* name) { m_name = name; } private: int m_level; bool m_enabled; const DebugEnabler* m_chain; const char* m_name; }; #if 0 /* for documentation generator */ /** * Convenience macro. * Does the same as @ref Debug if DEBUG is \#defined (compiling for debugging) * else it does not get compiled at all. */ void DDebug(int level, const char* format, ...); /** * Convenience macro. * Does the same as @ref 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, ...); /** * Convenience macro. * Does the same as @ref 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, ...); /** * Convenience macro. * Does the same as @ref Debug if XDEBUG is \#defined (compiling for extra * debugging) else it does not get compiled at all. */ void XDebug(int level, const char* format, ...); /** * Convenience macro. * Does the same as @ref 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, ...); /** * Convenience macro. * Does the same as @ref 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, ...); /** * Convenience macro. * Does the same as @ref Debug if NDEBUG is not \#defined * else it does not get compiled at all (compiling for mature release). */ void NDebug(int level, const char* format, ...); /** * Convenience macro. * Does the same as @ref 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, ...); /** * Convenience macro. * Does the same as @ref 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, ...); #endif #ifdef _DEBUG #undef DEBUG #define DEBUG #endif #ifdef XDEBUG #undef DEBUG #define DEBUG #endif #ifdef DEBUG #define DDebug Debug #else #ifdef _WINDOWS #define DDebug #else #define DDebug(arg...) #endif #endif #ifdef XDEBUG #define XDebug Debug #else #ifdef _WINDOWS #define XDebug #else #define XDebug(arg...) #endif #endif #ifndef NDEBUG #define NDebug Debug #else #ifdef _WINDOWS #define NDebug #else #define NDebug(arg...) #endif #endif /** * Outputs a debug string. * @param level The level of the message * @param format A printf() style format string */ YATE_API void Debug(int level, const char* format, ...) FORMAT_CHECK(2); /** * Outputs a debug string for a specific facility. * @param facility Facility that outputs the message * @param level The level of the message * @param format A printf() style format string */ YATE_API void Debug(const char* facility, int level, const char* format, ...) FORMAT_CHECK(3); /** * Outputs a debug string for a specific facility. * @param local Pointer to a DebugEnabler holding current debugging settings * @param level The level of the message * @param format A printf() style format string */ YATE_API void Debug(const DebugEnabler* local, int level, const char* format, ...) FORMAT_CHECK(3); /** * Outputs a string to the debug console with formatting * @param format A printf() style format string */ YATE_API void Output(const char* format, ...) FORMAT_CHECK(1); /** * 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. * @short An object that logs messages on creation and destruction */ class YATE_API Debugger { public: /** * Timestamp formatting */ enum Formatting { None = 0, Relative, // from program start Absolute, // from EPOCH (1-1-1970) Textual, // absolute GMT in YYYYMMDDhhmmss.uuuuuu format }; /** * The constructor prints the method entry message and indents. * @param name Name of the function or block entered, must be static * @param format printf() style format string */ Debugger(const char* name, const char* format = 0, ...); /** * The constructor prints the method entry message and indents. * @param level The level of the message * @param name Name of the function or block entered, must be static * @param format printf() style format string */ Debugger(int level, const char* name, const char* format = 0, ...); /** * The destructor prints the method leave message and deindents. */ ~Debugger(); /** * Set the output callback * @param outFunc Pointer to the output function, NULL to use stderr */ static void setOutput(void (*outFunc)(const char*,int) = 0); /** * Set the interactive output callback * @param outFunc Pointer to the output function, NULL to disable */ static void setIntOut(void (*outFunc)(const char*,int) = 0); /** * Enable or disable the debug output * @param enable Set to true to globally enable output * @param colorize Enable ANSI colorization of output */ static void enableOutput(bool enable = true, bool colorize = false); /** * Set the format of timestamps on output messages and set the time start reference * @param format Desired timestamp formatting */ static void setFormatting(Formatting format); private: const char* m_name; }; /** * 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 */ struct TokenDict { /** * Token to match */ const char* token; /** * Value the token translates to */ int value; }; class String; class Mutex; #if 0 /* for documentation generator */ /** * Macro to create a GenObject class from a base class and implement @ref GenObject::getObject * @param type Class that is declared * @param base Base class that is inherited */ void YCLASS(class type,class base); /** * Macro to implement @ref GenObject::getObject in a derived class * @param type Class that is declared * @param base Base class that is inherited */ void YCLASSIMP(class type,class base); /** * Macro to retrive a typed pointer to an interface from an object * @param type Class we want to return * @param pntr Pointer to the object we want to get the interface from * @return Pointer to the class we want or NULL */ class* YOBJECT(class type,GenObject* pntr); #endif #define YCLASS(type,base) \ public: virtual void* getObject(const String& name) const \ { return (name == #type) ? const_cast(this) : base::getObject(name); } #define YCLASSIMP(type,base) \ void* type::getObject(const String& name) const \ { return (name == #type) ? const_cast(this) : base::getObject(name); } #define YOBJECT(type,pntr) (static_cast((pntr) ? (pntr)->getObject(#type) : 0)) /** * An object with just a public virtual destructor */ class YATE_API GenObject { public: /** * Destructor. */ virtual ~GenObject() { } /** * Check if the object is still valid and safe to access. * Note that you should not trust this result unless the object is locked * by other means. * @return True if the object is still useable */ virtual bool alive() const; /** * Destroys the object, disposes the memory. */ virtual void destruct(); /** * Get a string representation of this object * @return A reference to a String representing this object * which is either null, the object itself (for objects derived from * String) or some form of identification */ virtual const String& toString() const; /** * Get a pointer to a derived class given that class name * @param name Name of the class we are asking for * @return Pointer to the requested class or NULL if this object doesn't implement it */ virtual void* getObject(const String& name) const; }; /** * Helper function that destroys a GenObject only if the pointer is non-NULL. * Use it instead of the delete operator. * @param obj Pointer (rvalue) to the object to destroy */ inline void destruct(GenObject* obj) { if (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. * @param obj Reference to pointer (lvalue) to the object to destroy */ template void destruct(Obj*& obj) { if (obj) { obj->destruct(); obj = 0; } } /** * A reference counted object. * Whenever using multiple inheritance you should inherit this class virtually. */ class YATE_API RefObject : public GenObject { public: /** * The constructor initializes the reference counter to 1! * Use deref() to destruct the object when safe */ RefObject() : m_refcount(1) { } /** * Destructor. */ virtual ~RefObject(); /** * Check if the object is still referenced and safe to access. * Note that you should not trust this result unless the object is locked * by other means. * @return True if the object is referenced and safe to access */ virtual bool alive() const; /** * Increments the reference counter if not already zero * @return True if the object was successfully referenced and is safe to access */ bool ref(); /** * Decrements the reference counter, destroys the object if it reaches zero * 
     * // Deref this object, return quickly if the object was deleted
     * if (deref()) return;
     *
* @return True if the object may have been deleted, false if it still exists and is safe to access */ bool deref(); /** * Get the current value of the reference counter * @return The value of the reference counter */ inline int refcount() const { return m_refcount; } /** * Refcounted objects should just have the counter decremented. * That will destroy them only when the refcount reaches zero. */ virtual void destruct(); /** * Retrieve the mutex that protects ref() and deref() for all objects * @return Reference to the global mutex used for all counter operations */ static Mutex& refMutex(); protected: /** * This method is called when the reference count reaches zero after * unlocking the mutex if the call to zeroRefsTest() returned true. * The default behaviour is to delete the object. */ virtual void zeroRefs(); /** * This method is called when the reference count reaches zero just before * calling zeroRefs() with the non-recursive mutex still locked. * Extra care must be taken to prevent deadlocks, normally the code should * only change some variables and return. * The default implementation just returns true. * @return True to call zeroRefs() after releasing the mutex */ virtual bool zeroRefsTest(); /** * Increments the reference counter if not already zero without locking * the mutex. The caller must make sure to hold the refMutex() locked. * @return True if the object was successfully referenced */ bool refInternal(); /** * Bring the object back alive by setting the reference counter to one. * Note that it works only if the counter was zero previously * @return True if the object was resurrected - its name may be Lazarus ;-) */ bool resurrect(); /** * Pre-destruction notification, called just before the object is deleted. * Unlike in the destructor it is safe to call virtual methods here. * Reimplementing this method allows to perform any object cleanups. */ virtual void destroyed(); private: int m_refcount; }; /** * Internal helper class providing a non-inline method to RefPointer. * Please don't use this class directly, use @ref RefPointer instead. * @short Internal helper class */ class YATE_API RefPointerBase { protected: /** * Default constructor, initialize to null pointer */ inline RefPointerBase() : m_pointer(0) { } /** * Set a new stored pointer * @param oldptr Pointer to the RefObject of the old stored object * @param newptr Pointer to the RefObject of the new stored object * @param pointer A void pointer to the derived class */ void assign(RefObject* oldptr, RefObject* newptr, void* pointer); /** * The untyped stored pointer that should be casted to a @ref RefObject derived class */ void* m_pointer; }; /** * @short Templated smart pointer class */ template class RefPointer : public RefPointerBase { protected: /** * Retrive the stored pointer * @return A typed pointer */ inline Obj* pointer() const { return static_cast(m_pointer); } /** * Set a new stored pointer * @param object Pointer to the new stored object */ inline void assign(Obj* object = 0) { RefPointerBase::assign(pointer(),object,object); } public: /** * Default constructor - creates a null smart pointer */ inline RefPointer() { } /** * Copy constructor, references the object * @param value Original RefPointer */ inline RefPointer(const RefPointer& value) { assign(value); } /** * Constructs an initialized smart pointer, references the object * @param object Pointer to object */ inline RefPointer(Obj* object) { assign(object); } /** * Destructs the pointer and dereferences the object */ inline ~RefPointer() { assign(); } /** * Assignment from smart pointer */ inline RefPointer& operator=(const RefPointer& value) { assign(value.pointer()); return *this; } /** * Assignment from regular pointer */ inline RefPointer& operator=(Obj* object) { assign(object); return *this; } /** * Conversion to regular pointer operator * @return The stored pointer */ inline operator Obj*() const { return pointer(); } /** * Member access operator */ inline Obj* operator->() const { return pointer(); } /** * Dereferencing operator */ inline Obj& operator*() const { return *pointer(); } }; /** * @short Templated pointer that can be inserted in a list */ template class GenPointer : public GenObject { private: /** * The stored pointer */ Obj* m_pointer; public: /** * Default constructor - creates a null pointer */ inline GenPointer() : m_pointer(0) { } /** * Copy constructor * @param value Original GenPointer */ inline GenPointer(const GenPointer& value) : m_pointer(value) { } /** * Constructs an initialized pointer * @param object Pointer to object */ inline GenPointer(Obj* object) : m_pointer(object) { } /** * Assignment from another GenPointer */ inline GenPointer& operator=(const GenPointer& value) { m_pointer = value; return *this; } /** * Assignment from regular pointer */ inline GenPointer& operator=(Obj* object) { m_pointer = object; return *this; } /** * Conversion to regular pointer operator * @return The stored pointer */ inline operator Obj*() const { return m_pointer; } /** * Member access operator */ inline Obj* operator->() const { return m_pointer; } /** * Dereferencing operator */ inline Obj& operator*() const { return *m_pointer; } }; /** * A simple single-linked object list handling class * @short An object list class */ class YATE_API ObjList : public GenObject { public: /** * Creates a new, empty list. */ ObjList(); /** * Destroys the list and everything in it. */ virtual ~ObjList(); /** * Get a pointer to a derived class given that class name * @param name Name of the class we are asking for * @return Pointer to the requested class or NULL if this object doesn't implement it */ virtual void* getObject(const String& name) const; /** * Get the number of elements in the list * @return Count of items */ unsigned int length() const; /** * Get the number of non-null objects in the list * @return Count of items */ unsigned int count() const; /** * Get the object associated to this list item * @return Pointer to the object or NULL */ inline GenObject* get() const { return m_obj; } /** * Set the object associated to this list item * @param obj Pointer to the new object to set * @param delold True to delete the old object (default) * @return Pointer to the old object if not destroyed */ GenObject* set(const GenObject* obj, bool delold = true); /** * Get the next item in the list * @return Pointer to the next item in list or NULL */ inline ObjList* next() const { return m_next; } /** * Get the last item in the list * @return Pointer to the last item in list */ ObjList* last() const; /** * Skip over NULL holding items in the list * @return Pointer to the first non NULL holding item in list or NULL */ ObjList* skipNull() const; /** * Advance in the list skipping over NULL holding items * @return Pointer to the next non NULL holding item in list or NULL */ ObjList* skipNext() const; /** * Pointer-like indexing operator * @param index Index of the list item to retrive * @return Pointer to the list item or NULL */ ObjList* operator+(int index) const; /** * Array-like indexing operator * @param index Index of the object to retrive * @return Pointer to the object or NULL */ GenObject* operator[](int index) const; /** * Array-like indexing operator * @param str String value of the object to locate * @return Pointer to the object or NULL */ GenObject* operator[](const String& str) const; /** * Get the item in the list that holds an object * @param obj Pointer to the object to search for * @return Pointer to the found item or NULL */ ObjList* find(const GenObject* obj) const; /** * Get the item in the list that holds an object by String value * @param str String value (toString) of the object to search for * @return Pointer to the found item or NULL */ ObjList* find(const String& str) const; /** * Insert an object at this point * @param obj Pointer to the object to insert * @param compact True to replace NULL values in list if possible * @return A pointer to the inserted list item */ ObjList* insert(const GenObject* obj, bool compact = true); /** * Append an object to the end of the list * @param obj Pointer to the object to append * @param compact True to replace NULL values in list if possible * @return A pointer to the inserted list item */ ObjList* append(const GenObject* obj, bool compact = true); /** * Delete this list item * @param delobj True to delete the object (default) * @return Pointer to the object if not destroyed */ GenObject* remove(bool delobj = true); /** * Delete the list item that holds a given object * @param obj Object to search in the list * @param delobj True to delete the object (default) * @return Pointer to the object if not destroyed */ GenObject* remove(GenObject* obj, bool delobj = true); /** * Clear the list and optionally delete all contained objects */ void clear(); /** * Get the automatic delete flag * @return True if will delete on destruct, false otherwise */ inline bool autoDelete() { return m_delete; } /** * Set the automatic delete flag * @param autodelete True to delete on destruct, false otherwise */ inline void setDelete(bool autodelete) { m_delete = autodelete; } private: ObjList* m_next; GenObject* m_obj; bool m_delete; }; /** * 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 * @short A list based Array */ class YATE_API Array : public RefObject { public: /** * Creates a new empty array. * @param columns Initial number of columns * @param rows Initial number of rows */ Array(int columns = 0, int rows = 0); /** * Destructor. Destructs all objects in the array */ virtual ~Array(); /** * Get a pointer to a derived class given that class name * @param name Name of the class we are asking for * @return Pointer to the requested class or NULL if this object doesn't implement it */ virtual void* getObject(const String& name) const; /** * Insert a row of objects * @param row List of objects to insert or NULL * @param index Number of the row to insert before, negative to append * @return True for success, false if index was larger than the array */ bool addRow(ObjList* row = 0, int index = -1); /** * Insert a column of objects * @param column List of objects to insert or NULL * @param index Number of the column to insert before, negative to append * @return True for success, false if index was larger than the array */ bool addColumn(ObjList* column = 0, int index = -1); /** * Delete an entire row of objects * @param index Number of the row to delete * @return True for success, false if index was out of bounds */ bool delRow(int index); /** * Delete an entire column of objects * @param index Number of the column to delete * @return True for success, false if index was out of bounds */ bool delColumn(int index); /** * Retrive an object from the array * @param column Number of the column in the array * @param row Number of the row in the array * @return Pointer to the stored object, NULL for out of bound indexes */ GenObject* get(int column, int row) const; /** * Store an object in the array * @param obj Object to store in the array * @param column Number of the column in the array * @param row Number of the row in the array * @return True for success, false if indexes were out of bounds */ bool set(GenObject* obj, int column, int row); /** * Get the number of rows in the array * @return Total number of rows */ inline int getRows() const { return m_rows; } /** * Get the number of columns in the array * @return Total number of columns */ inline int getColumns() const { return m_columns; } private: int m_rows; int m_columns; ObjList m_obj; }; class Regexp; class StringMatchPrivate; /** * 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. * @short A C-style string handling class */ class YATE_API String : public GenObject { public: /** * Creates a new, empty string. */ String(); /** * Creates a new initialized string. * @param value Initial value of the string * @param len Length of the data to copy, -1 for full string */ String(const char* value, int len = -1); /** * Creates a new initialized string. * @param value Character to fill the string * @param repeat How many copies of the character to use */ String(char value, unsigned int repeat = 1); /** * Creates a new initialized string from an integer. * @param value Value to convert to string */ String(int value); /** * Creates a new initialized string from an unsigned int. * @param value Value to convert to string */ String(unsigned int value); /** * Creates a new initialized string from a boolean. * @param value Value to convert to string */ String(bool value); /** * Copy constructor. * @param value Initial value of the string */ String(const String& value); /** * Constructor from String pointer. * @param value Initial value of the string */ String(const String* value); /** * Destroys the string, disposes the memory. */ virtual ~String(); /** * Get a pointer to a derived class given that class name * @param name Name of the class we are asking for * @return Pointer to the requested class or NULL if this object doesn't implement it */ virtual void* getObject(const String& name) const; /** * A static null String */ static const String& empty(); /** * A standard text representation of boolean values * @param value Boolean value to convert * @return Pointer to a text representation of the value */ inline static const char* boolText(bool value) { return value ? "true" : "false"; } /** * Get the value of the stored string. * @return The stored C string which may be NULL. */ inline const char* c_str() const { return m_string; } /** * Get a valid non-NULL C string. * @return The stored C string or a static "". */ inline const char* safe() const { return m_string ? m_string : ""; } /** * Get the length of the stored string. * @return The length of the stored string, zero for NULL. */ inline unsigned int length() const { return m_length; } /** * Checks if the string holds a NULL pointer. * @return True if the string holds NULL, false otherwise. */ inline bool null() const { return !m_string; } /** * Get the hash of the contained string. * @return The hash of the string. */ unsigned int hash() const; /** * Get the hash of an arbitrary string. * @return The hash of the string. */ static unsigned int hash(const char* value); /** * Clear the string and free the memory */ void clear(); /** * Extract the caracter at a given index * @param index Index of character in string * @return Character at given index or 0 if out of range */ char at(int index) const; /** * Substring extraction * @param offs Offset of the substring, negative to count from end * @param len Length of the substring, -1 for everything possible * @return A copy of the requested substring */ String substr(int offs, int len = -1) const; /** * Strip off leading and trailing blank characters */ String& trimBlanks(); /** * Override GenObject's method to return this String * @return A reference to this String */ virtual const String& toString() const; /** * Convert the string to an integer value. * @param defvalue Default to return if the string is not a number * @param base Numeration base, 0 to autodetect * @return The integer interpretation or defvalue. */ int toInteger(int defvalue = 0, int base = 0) const; /** * Convert the string to an integer value looking up first a token table. * @param tokens Pointer to an array of tokens to lookup first * @param defvalue Default to return if the string is not a token or number * @param base Numeration base, 0 to autodetect * @return The integer interpretation or defvalue. */ int toInteger(const TokenDict* tokens, int defvalue = 0, int base = 0) const; /** * Convert the string to a floating point value. * @param defvalue Default to return if the string is not a number * @return The floating-point interpretation or defvalue. */ double toDouble(double defvalue = 0.0) const; /** * Convert the string to a boolean value. * @param defvalue Default to return if the string is not a bool * @return The boolean interpretation or defvalue. */ bool toBoolean(bool defvalue = false) const; /** * Check if the string can be converted to a boolean value. * @return True if the string is a valid boolean. */ bool isBoolean() const; /** * Turn the string to an all-uppercase string * @return A reference to this String */ String& toUpper(); /** * Turn the string to an all-lowercase string * @return A reference to this String */ String& toLower(); /** * Indexing operator * @param index Index of character in string * @return Character at given index or 0 if out of range */ inline char operator[](int index) const { return at(index); } /** * Conversion to "const char *" operator. * @return Pointer to the internally stored string */ inline operator const char*() const { return m_string; }; /** * Assigns a new value to the string from a character block. * @param value New value of the string * @param len Length of the data to copy, -1 for full string * @return Reference to the String */ String& assign(const char* value, int len = -1); /** * Assigns a new value by filling with a repeated character * @param value Character to fill the string * @param repeat How many copies of the character to use * @return Reference to the String */ String& assign(char value, unsigned int repeat = 1); /** * Build a hexadecimal representation of a buffer of data * @param data Pointer to data to dump * @param len Length of the data buffer * @param sep Separator character to use between octets * @param upCase Set to true to use upper case characters in hexa * @return Reference to the String */ String& hexify(void* data, unsigned int len, char sep = 0, bool upCase = false); /** * Assignment operator. */ inline String& operator=(const String& value) { return operator=(value.c_str()); } /** * Assignment from String* operator. * @see TelEngine::strcpy */ inline String& operator=(const String* value) { return operator=(value ? value->c_str() : ""); } /** * Assignment from char* operator. * @see TelEngine::strcpy */ String& operator=(const char* value); /** * Assignment operator for single characters. */ String& operator=(char value); /** * Assignment operator for integers. */ String& operator=(int value); /** * Assignment operator for unsigned integers. */ String& operator=(unsigned int value); /** * Assignment operator for booleans. */ inline String& operator=(bool value) { return operator=(boolText(value)); } /** * Appending operator for strings. * @see TelEngine::strcat */ String& operator+=(const char* value); /** * Appending operator for single characters. */ String& operator+=(char value); /** * Appending operator for integers. */ String& operator+=(int value); /** * Appending operator for unsigned integers. */ String& operator+=(unsigned int value); /** * Appending operator for booleans. */ inline String& operator+=(bool value) { return operator+=(boolText(value)); } /** * Equality operator. */ bool operator==(const char* value) const; /** * Inequality operator. */ bool operator!=(const char* value) const; /** * Fast equality operator. */ bool operator==(const String& value) const; /** * Fast inequality operator. */ bool operator!=(const String& value) const; /** * Case-insensitive equality operator. */ bool operator&=(const char* value) const; /** * Case-insensitive inequality operator. */ bool operator|=(const char* value) const; /** * Stream style appending operator for C strings */ inline String& operator<<(const char* value) { return operator+=(value); } /** * Stream style appending operator for single characters */ inline String& operator<<(char value) { return operator+=(value); } /** * Stream style appending operator for integers */ inline String& operator<<(int value) { return operator+=(value); } /** * Stream style appending operator for unsigned integers */ inline String& operator<<(unsigned int value) { return operator+=(value); } /** * Stream style appending operator for booleans */ inline String& operator<<(bool value) { return operator+=(value); } /** * Stream style substring skipping operator. * It eats all characters up to and including the skip string */ String& operator>>(const char* skip); /** * Stream style extraction operator for single characters */ String& operator>>(char& store); /** * Stream style extraction operator for integers */ String& operator>>(int& store); /** * Stream style extraction operator for unsigned integers */ String& operator>>(unsigned int& store); /** * Stream style extraction operator for booleans */ String& operator>>(bool& store); /** * Conditional appending with a separator * @param value String to append * @param separator Separator to insert before the value * @param force True to allow appending empty strings */ String& append(const char* value, const char* separator = 0, bool force = false); /** * List members appending with a separator * @param list Pointer to ObjList whose @ref GenObject::toString() of the items will be appended * @param separator Separator to insert before each item in list * @param force True to allow appending empty strings */ String& append(const ObjList* list, const char* separator = 0, bool force = false); /** * List members appending with a separator * @param list Reference of ObjList whose @ref GenObject::toString() of the items will be appended * @param separator Separator to insert before each item in list * @param force True to allow appending empty strings */ inline String& append(const ObjList& list, const char* separator = 0, bool force = false) { return append(&list,separator,force); } /** * Explicit double append * @param value Value to append * @param decimals Number of decimals */ String& append(double value, unsigned int decimals = 3); /** * Locate the first instance of a character in the string * @param what Character to search for * @param offs Offset in string to start searching from * @return Offset of character or -1 if not found */ int find(char what, unsigned int offs = 0) const; /** * Locate the first instance of a substring in the string * @param what Substring to search for * @param offs Offset in string to start searching from * @return Offset of substring or -1 if not found */ int find(const char* what, unsigned int offs = 0) const; /** * Locate the last instance of a character in the string * @param what Character to search for * @return Offset of character or -1 if not found */ int rfind(char what) const; /** * Checks if the string starts with a substring * @param what Substring to search for * @param wordBreak Check if a word boundary follows the substring * @param caseInsensitive Compare case-insensitive if set * @return True if the substring occurs at the beginning of the string */ bool startsWith(const char* what, bool wordBreak = false, bool caseInsensitive = false) const; /** * Checks if the string ends with a substring * @param what Substring to search for * @param wordBreak Check if a word boundary precedes the substring * @param caseInsensitive Compare case-insensitive if set * @return True if the substring occurs at the end of the string */ bool endsWith(const char* what, bool wordBreak = false, bool caseInsensitive = false) const; /** * Checks if the string starts with a substring and removes it * @param what Substring to search for * @param wordBreak Check if a word boundary follows the substring; * this parameter defaults to True because the intended use of this * method is to separate commands from their parameters * @param caseInsensitive Compare case-insensitive if set * @return True if the substring occurs at the beginning of the string * and also removes the substring; if wordBreak is True any word * breaking characters are also removed */ bool startSkip(const char* what, bool wordBreak = true, bool caseInsensitive = false); /** * Checks if matches another string * @param value String to check for match * @return True if matches, false otherwise */ virtual bool matches(const String& value) const { return operator==(value); } /** * Checks if matches a regular expression and fill the match substrings * @param rexp Regular expression to check for match * @return True if matches, false otherwise */ bool matches(Regexp& rexp); /** * Get the offset of the last match * @param index Index of the submatch to return, 0 for full match * @return Offset of the last match, -1 if no match or not in range */ int matchOffset(int index = 0) const; /** * Get the length of the last match * @param index Index of the submatch to return, 0 for full match * @return Length of the last match, 0 if no match or out of range */ int matchLength(int index = 0) const; /** * Get a copy of a matched (sub)string * @param index Index of the submatch to return, 0 for full match * @return Copy of the matched substring */ inline String matchString(int index = 0) const { return substr(matchOffset(index),matchLength(index)); } /** * Create a string by replacing matched strings in a template * @param templ Template of the string to generate * @return Copy of template with "\0" - "\9" replaced with submatches */ String replaceMatches(const String& templ) const; /** * Get the total number of submatches from the last match, 0 if no match * @return Number of matching subexpressions */ int matchCount() const; /** * Splits the string at a delimiter character * @param separator Character where to split the string * @param emptyOK True if empty strings should be inserted in list * @return A newly allocated list of strings, must be deleted after use */ ObjList* split(char separator, bool emptyOK = true) const; /** * Create an escaped string suitable for use in messages * @param str String to convert to escaped format * @param extraEsc Character to escape other than the default ones * @return The string with special characters escaped */ static String msgEscape(const char* str, char extraEsc = 0); /** * Create an escaped string suitable for use in messages * @param extraEsc Character to escape other than the default ones * @return The string with special characters escaped */ inline String msgEscape(char extraEsc = 0) const { return msgEscape(c_str(),extraEsc); } /** * Decode an escaped string back to its raw form * @param str String to convert to unescaped format * @param errptr Pointer to an integer to receive the place of 1st error * @param extraEsc Character to unescape other than the default ones * @return The string with special characters unescaped */ static String msgUnescape(const char* str, int* errptr = 0, char extraEsc = 0); /** * Decode an escaped string back to its raw form * @param errptr Pointer to an integer to receive the place of 1st error * @param extraEsc Character to unescape other than the default ones * @return The string with special characters unescaped */ inline String msgUnescape(int* errptr = 0, char extraEsc = 0) const { return msgUnescape(c_str(),errptr,extraEsc); } /** * Create an escaped string suitable for use in SQL queries * @param str String to convert to escaped format * @param extraEsc Character to escape other than the default ones * @return The string with special characters escaped */ static String sqlEscape(const char* str, char extraEsc = 0); /** * Create an escaped string suitable for use in SQL queries * @param extraEsc Character to escape other than the default ones * @return The string with special characters escaped */ inline String sqlEscape(char extraEsc = 0) const { return sqlEscape(c_str(),extraEsc); } /** * Create an escaped string suitable for use in URIs * @param str String to convert to escaped format * @param extraEsc Character to escape other than the default ones * @return The string with special characters escaped */ static String uriEscape(const char* str, char extraEsc = 0); /** * Create an escaped string suitable for use in URI * @param extraEsc Character to escape other than the default ones * @return The string with special characters escaped */ inline String uriEscape(char extraEsc = 0) const { return uriEscape(c_str(),extraEsc); } /** * Decode an URI escaped string back to its raw form * @param str String to convert to unescaped format * @param errptr Pointer to an integer to receive the place of 1st error * @return The string with special characters unescaped */ static String uriUnescape(const char* str, int* errptr = 0); /** * Decode an URI escaped string back to its raw form * @param errptr Pointer to an integer to receive the place of 1st error * @return The string with special characters unescaped */ inline String uriUnescape(int* errptr = 0) const { return uriUnescape(c_str(),errptr); } protected: /** * Called whenever the value changed (except in constructors). */ virtual void changed(); private: void clearMatches(); char* m_string; unsigned int m_length; // I hope every C++ compiler now knows about mutable... mutable unsigned int m_hash; StringMatchPrivate* m_matches; }; /** * Utility function to replace NULL string pointers with an empty string * @param str Pointer to a C string that may be NULL * @return Original pointer or pointer to an empty string */ inline const char *c_safe(const char* str) { return str ? str : ""; } /** * Utility function to check if a C string is null or empty * @param str Pointer to a C string * @return True if str is NULL or starts with a NUL character */ inline bool null(const char* str) { return !(str && *str); } /** * Concatenation operator for strings. */ YATE_API String operator+(const String& s1, const String& s2); /** * Concatenation operator for strings. */ YATE_API String operator+(const String& s1, const char* s2); /** * Concatenation operator for strings. */ YATE_API String operator+(const char* s1, const String& s2); /** * Prevent careless programmers from overwriting the string * @see TelEngine::String::operator= */ inline const char *strcpy(String& dest, const char* src) { dest = src; return dest.c_str(); } /** * Prevent careless programmers from overwriting the string * @see TelEngine::String::operator+= */ inline const char *strcat(String& dest, const char* src) { dest += src; return dest.c_str(); } /** * Utility function to look up a string in a token table, * interpret as number if it fails * @param str String to look up * @param tokens Pointer to the token table * @param defvalue Value to return if lookup and conversion fail * @param base Default base to use to convert to number */ YATE_API int lookup(const char* str, const TokenDict* tokens, int defvalue = 0, int base = 0); /** * Utility function to look up a number in a token table * @param value Value to search for * @param tokens Pointer to the token table * @param defvalue Value to return if lookup fails */ YATE_API const char* lookup(int value, const TokenDict* tokens, const char* defvalue = 0); /** * A regular expression matching class. * @short A regexp matching class */ class YATE_API Regexp : public String { friend class String; public: /** * Creates a new, empty regexp. */ Regexp(); /** * Creates a new initialized regexp. * @param value Initial value of the regexp. * @param extended True to use POSIX Extended Regular Expression syntax * @param insensitive True to not differentiate case */ Regexp(const char* value, bool extended = false, bool insensitive = false); /** * Copy constructor. * @param value Initial value of the regexp. */ Regexp(const Regexp& value); /** * Destroys the regexp, disposes the memory. */ virtual ~Regexp(); /** * Assignment from char* operator. */ inline Regexp& operator=(const char* value) { String::operator=(value); return *this; } /** * Makes sure the regular expression is compiled * @return True if successfully compiled, false on error */ bool compile(); /** * Checks if the pattern matches a given value * @param value String to check for match * @return True if matches, false otherwise */ bool matches(const char* value) const; /** * Checks if the pattern matches a string * @param value String to check for match * @return True if matches, false otherwise */ virtual bool matches(const String& value) const { return Regexp::matches(value.safe()); } /** * Change the expression matching flags * @param extended True to use POSIX Extended Regular Expression syntax * @param insensitive True to not differentiate case */ void setFlags(bool extended, bool insensitive); /** * Return the POSIX Extended syntax flag * @return True if using POSIX Extended Regular Expression syntax */ bool isExtended() const; /** * Return the Case Insensitive flag * @return True if not differentiating case */ bool isCaseInsensitive() const; protected: /** * Called whenever the value changed (except in constructors) to recompile. */ virtual void changed(); private: void cleanup(); bool matches(const char *value, StringMatchPrivate *matchlist); void* m_regexp; int m_flags; }; /** * A string class with a hashed string name * @short A named string class. */ class YATE_API NamedString : public String { public: /** * Creates a new named string. * @param name Name of this string * @param value Initial value of the string. */ NamedString(const char* name, const char* value = 0); /** * Retrive the name of this string. * @return A hashed string with the name of the string */ inline const String& name() const { return m_name; } /** * Get a string representation of this object * @return A reference to the name of this object */ virtual const String& toString() const; /** * Value assignment operator */ inline NamedString& operator=(const char* value) { String::operator=(value); return *this; } private: NamedString(); // no default constructor please String m_name; }; /** * 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. * @short A hashed object list class */ class YATE_API HashList : public GenObject { public: /** * Creates a new, empty list. * @param size Number of classes to divide the objects */ HashList(unsigned int size = 17); /** * Destroys the list and everything in it. */ virtual ~HashList(); /** * Get a pointer to a derived class given that class name * @param name Name of the class we are asking for * @return Pointer to the requested class or NULL if this object doesn't implement it */ virtual void* getObject(const String& name) const; /** * Get the number of hash entries * @return Count of hash entries */ inline unsigned int length() const { return m_size; } /** * Get the number of non-null objects in the list * @return Count of items */ unsigned int count() const; /** * Retrive one of the internal object lists. This method should be used * only to iterate all objects in the list. * @param index Index of the internal list to retrive * @return Pointer to the list or NULL */ inline ObjList* getList(unsigned int index) const { return (index < m_size) ? m_lists[index] : 0; } /** * Retrive one of the internal object lists knowing the hash value. * @param hash Hash of the internal list to retrive * @return Pointer to the list or NULL if never filled */ inline ObjList* getHashList(unsigned int hash) const { return getList(hash % m_size); } /** * Retrive one of the internal object lists knowing the String value. * @param str String whose hash internal list is to retrive * @return Pointer to the list or NULL if never filled */ inline ObjList* getHashList(const String& str) const { return getHashList(str.hash()); } /** * Array-like indexing operator * @param str String value of the object to locate * @return Pointer to the first object or NULL */ GenObject* operator[](const String& str) const; /** * Get the item in the list that holds an object * @param obj Pointer to the object to search for * @return Pointer to the found item or NULL */ ObjList* find(const GenObject* obj) const; /** * Get the item in the list that holds an object by String value * @param str String value (toString) of the object to search for * @return Pointer to the first found item or NULL */ ObjList* find(const String& str) const; /** * Appends an object to the hashed list * @param obj Pointer to the object to append * @return A pointer to the inserted list item */ ObjList* append(const GenObject* obj); /** * Delete the list item that holds a given object * @param obj Object to search in the list * @param delobj True to delete the object (default) * @return Pointer to the object if not destroyed */ GenObject* remove(GenObject* obj, bool delobj = true); /** * Clear the list and optionally delete all contained objects */ void clear(); /** * Resync the list by checking if a stored object belongs to the list * according to its hash * @param obj Object to resync in the list * @return True if object was in the wrong list and had to be moved */ bool resync(GenObject* obj); /** * Resync the list by checking if all stored objects belong to the list * according to their hash * @return True if at least one object had to be moved */ bool resync(); private: unsigned int m_size; ObjList** m_lists; }; /** * 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. * @short Class used to iterate the items of a list */ class YATE_API ListIterator { public: /** * Constructor used to iterate trough an ObjList. * The image of the list is frozen at the time the constructor executes * @param list List to get the objects from */ ListIterator(ObjList& list); /** * Constructor used to iterate trough a HashList. * The image of the list is frozen at the time the constructor executes * @param list List to get the objects from */ ListIterator(HashList& list); /** * Destructor - frees the allocated memory */ ~ListIterator(); /** * Get the number of elements in the list * @return Count of items in the internal list */ inline unsigned int length() const { return m_length; } /** * Get an arbitrary element in the iterator's list image. * Items that were removed from list or are not alive are not returned. * @param index Position to get the item from * @return Pointer to the list item or NULL if out of range or item removed */ GenObject* get(unsigned int index) const; /** * Get the current element and advance the current index. * Items that were removed from list or are not alive are skipped over. * An example of typical usage: * 
     * ListIterator iter(list);
     * while (GenObject* obj = iter.get()) {
     *     do_something_with(obj);
     * }
     *
* @return Pointer to a list item or NULL if advanced past end (eof) */ GenObject* get(); /** * Check if the current pointer is past the end of the list * @return True if there are no more entries left */ inline bool eof() const { return m_current >= m_length; } /** * Reset the iterator index to the first position in the list */ inline void reset() { m_current = 0; } private: ObjList* m_objList; HashList* m_hashList; GenObject** m_objects; unsigned int m_length; unsigned int m_current; }; /** * The Time class holds a time moment with microsecond accuracy * @short A time holding class */ class YATE_API Time { public: /** * Constructs a Time object from the current time */ inline Time() : m_time(now()) { } /** * Constructs a Time object from a given time * @param usec Time in microseconds */ inline Time(u_int64_t usec) : m_time(usec) { } /** * Constructs a Time object from a timeval structure pointer * @param tv Pointer to the timeval structure */ inline Time(const struct timeval* tv) : m_time(fromTimeval(tv)) { } /** * Constructs a Time object from a timeval structure * @param tv Reference of the timeval structure */ inline Time(const struct timeval& tv) : m_time(fromTimeval(tv)) { } /** * Do-nothing destructor that keeps the compiler from complaining * about inlining derivates or members of Time type */ inline ~Time() { } /** * Get time in seconds * @return Time in seconds since the Epoch */ inline u_int32_t sec() const { return (u_int32_t)((m_time+500000) / 1000000); } /** * Get time in milliseconds * @return Time in milliseconds since the Epoch */ inline u_int64_t msec() const { return (m_time+500) / 1000; } /** * Get time in microseconds * @return Time in microseconds since the Epoch */ inline u_int64_t usec() const { return m_time; } /** * Conversion to microseconds operator */ inline operator u_int64_t() const { return m_time; } /** * Assignment operator. */ inline Time& operator=(u_int64_t usec) { m_time = usec; return *this; } /** * Offsetting operator. */ inline Time& operator+=(int64_t delta) { m_time += delta; return *this; } /** * Offsetting operator. */ inline Time& operator-=(int64_t delta) { m_time -= delta; return *this; } /** * Fill in a timeval struct from a value in microseconds * @param tv Pointer to the timeval structure */ inline void toTimeval(struct timeval* tv) const { toTimeval(tv, m_time); } /** * Fill in a timeval struct from a value in microseconds * @param tv Pointer to the timeval structure * @param usec Time to convert to timeval */ static void toTimeval(struct timeval* tv, u_int64_t usec); /** * Convert time in a timeval struct to microseconds * @param tv Pointer to the timeval structure * @return Corresponding time in microseconds or zero if tv is NULL */ static u_int64_t fromTimeval(const struct timeval* tv); /** * Convert time in a timeval struct to microseconds * @param tv Reference of the timeval structure * @return Corresponding time in microseconds */ inline static u_int64_t fromTimeval(const struct timeval& tv) { return fromTimeval(&tv); } /** * Get the current system time in microseconds * @return Time in microseconds since the Epoch */ static u_int64_t now(); /** * Get the current system time in milliseconds * @return Time in milliseconds since the Epoch */ static u_int64_t msecNow(); /** * Get the current system time in seconds * @return Time in seconds since the Epoch */ static u_int32_t secNow(); private: u_int64_t m_time; }; /** * The DataBlock holds a data buffer with no specific formatting. * @short A class that holds just a block of raw data */ class YATE_API DataBlock : public GenObject { public: /** * Constructs an empty data block */ DataBlock(); /** * Copy constructor */ DataBlock(const DataBlock& value); /** * Constructs an initialized data block * @param value Data to assign, may be NULL to fill with zeros * @param len Length of data, may be zero (then value is ignored) * @param copyData True to make a copy of the data, false to just insert the pointer */ DataBlock(void* value, unsigned int len, bool copyData = true); /** * Destroys the data, disposes the memory. */ virtual ~DataBlock(); /** * Get a pointer to a derived class given that class name * @param name Name of the class we are asking for * @return Pointer to the requested class or NULL if this object doesn't implement it */ virtual void* getObject(const String& name) const; /** * A static empty data block */ static const DataBlock& empty(); /** * Get a pointer to the stored data. * @return A pointer to the data or NULL. */ inline void* data() const { return m_data; } /** * Checks if the block holds a NULL pointer. * @return True if the block holds NULL, false otherwise. */ inline bool null() const { return !m_data; } /** * Get the length of the stored data. * @return The length of the stored data, zero for NULL. */ inline unsigned int length() const { return m_length; } /** * Clear the data and optionally free the memory * @param deleteData True to free the deta block, false to just forget it */ void clear(bool deleteData = true); /** * Assign data to the object * @param value Data to assign, may be NULL to fill with zeros * @param len Length of data, may be zero (then value is ignored) * @param copyData True to make a copy of the data, false to just insert the pointer */ DataBlock& assign(void* value, unsigned int len, bool copyData = true); /** * Append data to the current block * @param value Data to append */ void append(const DataBlock& value); /** * Append a String to the current block * @param value String to append */ void append(const String& value); /** * Insert data before the current block * @param value Data to insert */ void insert(const DataBlock& value); /** * Truncate the data block * @param len The maximum length to keep */ void truncate(unsigned int len); /** * Cut off a number of bytes from the data block * @param len Amount to cut, positive to cut from end, negative to cut from start of block */ void cut(int len); /** * Assignment operator. */ DataBlock& operator=(const DataBlock& value); /** * Appending operator. */ inline DataBlock& operator+=(const DataBlock& value) { append(value); return *this; } /** * Appending operator for Strings. */ inline DataBlock& operator+=(const String& value) { append(value); return *this; } /** * Convert data from a different format * @param src Source data block * @param sFormat Name of the source format * @param dFormat Name of the destination format * @param maxlen Maximum amount to convert, 0 to use source * @return True if converted successfully, false on failure */ bool convert(const DataBlock& src, const String& sFormat, const String& dFormat, unsigned maxlen = 0); private: void* m_data; unsigned int m_length; }; /** * A class to compute and check MD5 digests * @short A standard MD5 digest calculator */ class YATE_API MD5 { public: /** * Construct a fresh initialized instance */ MD5(); /** * Copy constructor * @param original MD5 instance to copy */ MD5(const MD5& original); /** * Construct a digest from a buffer of data * @param buf Pointer to the data to be included in digest * @param len Length of data in the buffer */ MD5(const void* buf, unsigned int len); /** * Construct a digest from a binary DataBlock * @param data Binary data to be included in digest */ MD5(const DataBlock& data); /** * Construct a digest from a String * @param str String to be included in digest */ MD5(const String& str); /** * Destroy the instance, free allocated memory */ ~MD5(); /** * Assignment operator. */ MD5& operator=(const MD5& original); /** * Clear the digest and prepare for reuse */ void clear(); /** * Finalize the digest computation, make result ready. * Subsequent calls to @ref update() will fail */ void finalize(); /** * Update the digest from a buffer of data * @param buf Pointer to the data to be included in digest * @param len Length of data in the buffer * @return True if success, false if @ref finalize() was already called */ bool update(const void* buf, unsigned int len); /** * Update the digest from the content of a DataBlock * @param data Data to be included in digest * @return True if success, false if @ref finalize() was already called */ inline bool update(const DataBlock& data) { return update(data.data(), data.length()); } /** * Update the digest from the content of a String * @param str String to be included in digest * @return True if success, false if @ref finalize() was already called */ inline bool update(const String& str) { return update(str.c_str(), str.length()); } /** * MD5 updating operator for Strings */ inline MD5& operator<<(const String& value) { update(value); return *this; } /** * MD5 updating operator for DataBlocks */ inline MD5& operator<<(const DataBlock& data) { update(data); return *this; } /** * MD5 updating operator for C strings */ MD5& operator<<(const char* value); /** * Returns a pointer to the raw 16-byte binary value of the message digest. * The digest is finalized if if wasn't already * @return Pointer to the raw digest data or NULL if some error occured */ const unsigned char* rawDigest(); /** * Return the length of the raw binary digest * @return Constant value of 16 */ inline static unsigned int rawLength() { return 16; } /** * Returns the standard hexadecimal representation of the message digest. * The digest is finalized if if wasn't already * @return A String which holds the hex digest or a null one if some error occured */ const String& hexDigest(); private: void init(); void* m_private; String m_hex; unsigned char m_bin[16]; }; /** * A class to compute and check SHA1 digests * @short A standard SHA1 digest calculator */ class YATE_API SHA1 { public: /** * Construct a fresh initialized instance */ SHA1(); /** * Copy constructor * @param original SHA1 instance to copy */ SHA1(const SHA1& original); /** * Construct a digest from a buffer of data * @param buf Pointer to the data to be included in digest * @param len Length of data in the buffer */ SHA1(const void* buf, unsigned int len); /** * Construct a digest from a binary DataBlock * @param data Binary data to be included in digest */ SHA1(const DataBlock& data); /** * Construct a digest from a String * @param str String to be included in digest */ SHA1(const String& str); /** * Destroy the instance, free allocated memory */ ~SHA1(); /** * Assignment operator. */ SHA1& operator=(const SHA1& original); /** * Clear the digest and prepare for reuse */ void clear(); /** * Finalize the digest computation, make result ready. * Subsequent calls to @ref update() will fail */ void finalize(); /** * Update the digest from a buffer of data * @param buf Pointer to the data to be included in digest * @param len Length of data in the buffer * @return True if success, false if @ref finalize() was already called */ bool update(const void* buf, unsigned int len); /** * Update the digest from the content of a DataBlock * @param data Data to be included in digest * @return True if success, false if @ref finalize() was already called */ inline bool update(const DataBlock& data) { return update(data.data(), data.length()); } /** * Update the digest from the content of a String * @param str String to be included in digest * @return True if success, false if @ref finalize() was already called */ inline bool update(const String& str) { return update(str.c_str(), str.length()); } /** * SHA1 updating operator for Strings */ inline SHA1& operator<<(const String& value) { update(value); return *this; } /** * SHA1 updating operator for DataBlocks */ inline SHA1& operator<<(const DataBlock& data) { update(data); return *this; } /** * SHA1 updating operator for C strings */ SHA1& operator<<(const char* value); /** * Returns a pointer to the raw 20-byte binary value of the message digest. * The digest is finalized if if wasn't already * @return Pointer to the raw digest data or NULL if some error occured */ const unsigned char* rawDigest(); /** * Return the length of the raw binary digest * @return Constant value of 20 */ inline static unsigned int rawLength() { return 20; } /** * Returns the standard hexadecimal representation of the message digest. * The digest is finalized if if wasn't already * @return A String which holds the hex digest or a null one if some error occured */ const String& hexDigest(); private: void init(); void* m_private; String m_hex; unsigned char m_bin[20]; }; /** * This class holds a named list of named strings * @short A named string container class */ class YATE_API NamedList : public String { public: /** * Creates a new named list. * @param name Name of the list - must not be NULL or empty */ NamedList(const char* name); /** * Copy constructor * @param original Named list we are copying */ NamedList(const NamedList& original); /** * Get a pointer to a derived class given that class name * @param name Name of the class we are asking for * @return Pointer to the requested class or NULL if this object doesn't implement it */ virtual void* getObject(const String& name) const; /** * Get the number of parameters * @return Count of named strings */ inline unsigned int length() const { return m_params.length(); } /** * Get the number of non-null parameters * @return Count of existing named strings */ inline unsigned int count() const { return m_params.count(); } /** * Add a named string to the parameter list. * @param param Parameter to add */ NamedList& addParam(NamedString* param); /** * Add a named string to the parameter list. * @param name Name of the new string * @param value Value of the new string */ NamedList& addParam(const char* name, const char* value); /** * Set a named string in the parameter list. * @param param Parameter to set or add */ NamedList& setParam(NamedString* param); /** * Set a named string in the parameter list. * @param name Name of the string * @param value Value of the string */ NamedList& setParam(const char* name, const char* value); /** * Clears all instances of a named string in the parameter list. * @param name Name of the string to remove * @param childSep If set clears all child parameters in format name+childSep+anything */ NamedList& clearParam(const String& name, char childSep = 0); /** * Copy a parameter from another NamedList, clears it if not present there * @param original NamedList to copy the parameter from * @param name Name of the string to copy or clear * @param childSep If set copies all child parameters in format name+childSep+anything */ NamedList& copyParam(const NamedList& original, const String& name, char childSep = 0); /** * Copy multiple parameters from another NamedList, clears them if not present there * @param original NamedList to copy the parameters from * @param list List of objects (usually String) whose name (blanks stripped) is used as parameters names * @param childSep If set copies all child parameters in format name+childSep+anything */ NamedList& copyParams(const NamedList& original, ObjList* list, char childSep = 0); /** * Copy multiple parameters from another NamedList, clears it if not present there * @param original NamedList to copy the parameter from * @param list Comma separated list of parameters to copy or clear * @param childSep If set copies all child parameters in format name+childSep+anything */ NamedList& copyParams(const NamedList& original, const String& list, char childSep = 0); /** * Get the index of a named string in the parameter list. * @param param Pointer to the parameter to locate * @return Index of the named string or -1 if not found */ int getIndex(const NamedString* param) const; /** * Get the index of first matching named string in the parameter list. * @param name Name of parameter to locate * @return Index of the first matching named string or -1 if not found */ int getIndex(const String& name) const; /** * Locate a named string in the parameter list. * @param name Name of parameter to locate * @return A pointer to the named string or NULL. */ NamedString* getParam(const String& name) const; /** * Locate a named string in the parameter list. * @param index Index of the parameter to locate * @return A pointer to the named string or NULL. */ NamedString* getParam(unsigned int index) const; /** * Retrive the value of a named parameter. * @param name Name of parameter to locate * @param defvalue Default value to return if not found * @return The string contained in the named parameter or the default */ const char* getValue(const String& name, const char* defvalue = 0) const; /** * Retrive the numeric value of a parameter. * @param name Name of parameter to locate * @param defvalue Default value to return if not found * @return The number contained in the named parameter or the default */ int getIntValue(const String& name, int defvalue = 0) const; /** * Retrive the numeric value of a parameter trying first a table lookup. * @param name Name of parameter to locate * @param tokens A pointer to an array of tokens to try to lookup * @param defvalue Default value to return if not found * @return The number contained in the named parameter or the default */ int getIntValue(const String& name, const TokenDict* tokens, int defvalue = 0) const; /** * Retrive the floating point value of a parameter. * @param name Name of parameter to locate * @param defvalue Default value to return if not found * @return The number contained in the named parameter or the default */ double getDoubleValue(const String& name, double defvalue = 0.0) const; /** * Retrive the boolean value of a parameter. * @param name Name of parameter to locate * @param defvalue Default value to return if not found * @return The boolean value contained in the named parameter or the default */ bool getBoolValue(const String& name, bool defvalue = false) const; /** * Replaces all ${paramname} in a String with the corresponding parameters * @param str String in which the replacements will be made * @param sqlEsc True to apply SQL escaping to parameter values * @param extraEsc Character to escape other than the SQL default ones * @return Number of replacements made, -1 if an error occured */ int replaceParams(String& str, bool sqlEsc = false, char extraEsc = 0) const; private: NamedList(); // no default constructor please NamedList& operator=(const NamedList& value); // no assignment please ObjList m_params; }; /** * Uniform Resource Identifier encapsulation and parser. * For efficiency reason the parsing is delayed as long as possible * @short Encapsulation for an URI */ class YATE_API URI : public String { public: /** * Empty URI constructor */ URI(); /** * Copy constructor * @param uri Original URI to copy */ URI(const URI& uri); /** * Constructor from a String that gets parsed later * @param uri String form of the URI */ URI(const String& uri); /** * Constructor from a C string that gets parsed later * @param uri String form of the URI */ URI(const char* uri); /** * Constructor from URI components * @param proto Protocol - something like "http", "sip", etc. * @param user User component of the URI * @param host Hostname component of the URI * @param port Port part of the URI (optional) * @param desc Description part in front of the URI (optional) */ URI(const char* proto, const char* user, const char* host, int port = 0, const char* desc = 0); /** * Calling this method ensures the string URI is parsed into components */ void parse() const; /** * Assignment operator from URI * @param value New URI value to assign */ inline URI& operator=(const URI& value) { String::operator=(value); return *this; } /** * Assignment operator from String * @param value New URI value to assign */ inline URI& operator=(const String& value) { String::operator=(value); return *this; } /** * Assignment operator from C string * @param value New URI value to assign */ inline URI& operator=(const char* value) { String::operator=(value); return *this; } /** * Access method to the description part of the URI * @return Description part of the URI */ inline const String& getDescription() const { parse(); return m_desc; } /** * Access method to the protocol part of the URI * @return Protocol part of the URI */ inline const String& getProtocol() const { parse(); return m_proto; } /** * Access method to the user part of the URI * @return User component of the URI */ inline const String& getUser() const { parse(); return m_user; } /** * Access method to the host part of the URI * @return Hostname part of the URI */ inline const String& getHost() const { parse(); return m_host; } /** * Access method to the port part of the URI * @return Port of the URI, zero if not set */ inline int getPort() const { parse(); return m_port; } protected: /** * Notification method called whenever the string URI has changed. * The default behaviour is to invalidate the parsed flag and cal the * method inherited from @ref String. */ virtual void changed(); mutable bool m_parsed; mutable String m_desc; mutable String m_proto; mutable String m_user; mutable String m_host; mutable int m_port; }; class MutexPrivate; class ThreadPrivate; /** * A simple mutual exclusion for locking access between threads * @short Mutex support */ class YATE_API Mutex { friend class MutexPrivate; public: /** * Construct a new unlocked fast mutex */ Mutex(); /** * Construct a new unlocked mutex * @param recursive True if the mutex has to be recursive (reentrant), * false for a normal fast mutex */ Mutex(bool recursive); /** * Copy constructor creates a shared mutex * @param original Reference of the mutex to share */ Mutex(const Mutex& original); /** * Destroy the mutex */ ~Mutex(); /** * Assignment operator makes the mutex shared with the original * @param original Reference of the mutex to share */ Mutex& operator=(const Mutex& original); /** * Attempt to lock the mutex and eventually wait for it * @param maxwait Time in microseconds to wait for the mutex, -1 wait forever * @return True if successfully locked, false on failure */ bool lock(long maxwait = -1); /** * Unlock the mutex, does never wait */ void unlock(); /** * Check if the mutex is currently locked - as it's asynchronous it * guarantees nothing if other thread changes the mutex's status * @return True if the mutex was locked when the function was called */ bool locked() const; /** * Check if the mutex is unlocked (try to lock and unlock the mutex) * @param maxwait Time in microseconds to wait for the mutex, -1 wait forever * @return True if successfully locked and unlocked, false on failure */ bool check(long maxwait = -1); /** * Check if this mutex is recursive or not * @return True if this is a recursive mutex, false for a fast mutex */ bool recursive() const; /** * Get the number of mutexes counting the shared ones only once * @return Count of individual mutexes */ static int count(); /** * Get the number of currently locked mutexes * @return Count of locked mutexes, should be zero at program exit */ static int locks(); /** * Set a maximum mutex wait time for debugging purposes * @param maxwait Maximum time in microseconds to wait for any mutex * when no time limit was requested, zero to disable limit */ static void wait(unsigned long maxwait); private: MutexPrivate* privDataCopy() const; MutexPrivate* m_private; }; /** * A lock is a stack allocated (automatic) object that locks a mutex on * creation and unlocks it on destruction - typically when exiting a block * @short Ephemeral mutex locking object */ class YATE_API Lock { public: /** * Create the lock, try to lock the mutex * @param mutex Reference to the mutex to lock * @param maxwait Time in microseconds to wait for the mutex, -1 wait forever */ inline Lock(Mutex& mutex, long maxwait = -1) { m_mutex = mutex.lock(maxwait) ? &mutex : 0; } /** * Create the lock, try to lock the mutex * @param mutex Pointer to the mutex to lock * @param maxwait Time in microseconds to wait for the mutex, -1 wait forever */ inline Lock(Mutex* mutex, long maxwait = -1) { m_mutex = (mutex && mutex->lock(maxwait)) ? mutex : 0; } /** * Destroy the lock, unlock the mutex if it was locked */ inline ~Lock() { if (m_mutex) m_mutex->unlock(); } /** * Return a pointer to the mutex this lock holds * @return A mutex pointer or NULL if locking failed */ inline Mutex* mutex() const { return m_mutex; } /** * Unlock the mutex if it was locked and drop the reference to it */ inline void drop() { if (m_mutex) m_mutex->unlock(); m_mutex = 0; } private: Mutex* m_mutex; /** Make sure no Lock is ever created on heap */ inline void* operator new(size_t); /** Never allocate an array of this class */ inline void* operator new[](size_t); /** No copy constructor */ inline Lock(const Lock&); }; /** * 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 * @short Ephemeral double mutex locking object */ class YATE_API Lock2 { public: /** * Create the dual lock, try to lock each mutex * @param mx1 Pointer to the first mutex to lock * @param mx2 Pointer to the second mutex to lock * @param maxwait Time in microseconds to wait for each mutex, -1 wait forever */ inline Lock2(Mutex* mx1, Mutex* mx2, long maxwait = -1) : m_mx1(0), m_mx2(0) { lock(mx1,mx2,maxwait); } /** * Create the dual lock, try to lock each mutex * @param mx1 Reference to the first mutex to lock * @param mx2 Reference to the second mutex to lock * @param maxwait Time in microseconds to wait for each mutex, -1 wait forever */ inline Lock2(Mutex& mx1, Mutex& mx2, long maxwait = -1) : m_mx1(0), m_mx2(0) { lock(&mx1,&mx2); } /** * Destroy the lock, unlock the mutex if it was locked */ inline ~Lock2() { drop(); } /** * Check if the locking succeeded * @return True if all mutexes were locked */ inline bool locked() const { return m_mx1 != 0; } /** * Lock in a new pair of mutexes. Any existing locks are dropped * @param mx1 Pointer to the first mutex to lock * @param mx2 Pointer to the second mutex to lock * @param maxwait Time in microseconds to wait for each mutex, -1 wait forever * @return True on success - non-NULL mutexes locked */ bool lock(Mutex* mx1, Mutex* mx2, long maxwait = -1); /** * Lock in a new pair of mutexes * @param mx1 Reference to the first mutex to lock * @param mx2 Reference to the second mutex to lock * @param maxwait Time in microseconds to wait for each mutex, -1 wait forever * @return True on success - both locked */ inline bool lock(Mutex& mx1, Mutex& mx2, long maxwait = -1) { return lock(&mx1,&mx2); } /** * Unlock both mutexes if they were locked and drop the references */ void drop(); private: Mutex* m_mx1; Mutex* m_mx2; /** Make sure no Lock2 is ever created on heap */ inline void* operator new(size_t); /** Never allocate an array of this class */ inline void* operator new[](size_t); /** No copy constructor */ inline Lock2(const Lock2&); }; /** * This class holds the action to execute a certain task, usually in a * different execution thread. * @short Encapsulates a runnable task */ class YATE_API Runnable { public: /** * This method is called in another thread to do the actual job. * When it returns the job or thread terminates. */ virtual void run() = 0; /** * Do-nothing destructor, placed here just to shut up GCC 4+ */ virtual ~Runnable(); }; /** * 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. * @short Thread support class */ class YATE_API Thread : public Runnable { friend class ThreadPrivate; friend class MutexPrivate; public: /** * Running priorities, their mapping is operating system dependent */ enum Priority { Lowest, Low, Normal, High, Highest }; /** * This method is called when the current thread terminates. */ virtual void cleanup(); /** * Actually starts running the new thread which lingers after creation * @return False if an error occured, true if started ok */ bool startup(); /** * Check if the thread creation failed * @return True if an error occured, false if created ok */ bool error() const; /** * Check if the thread is running or not * @return True if running, false if it has terminated or no startup called */ bool running() const; /** * Count how many Yate mutexes are kept locked by this thread * @return Number of Mutex locks held by this thread */ inline int locks() const { return m_locks; } /** * Check if the thread is currently helding or attempting to lock a mutex * @return True if the current thread is in an unsafe to cancel state */ inline bool locked() const { return m_locking || m_locks; } /** * Get the name of this thread * @return The pointer that was passed in the constructor */ const char* name() const; /** * Get the name of the currently running thread * @return The pointer that was passed in the thread's constructor */ static const char* currentName(); /** * Give up the currently running timeslice. Note that on some platforms * it also sleeps for the operating system's scheduler resolution * @param exitCheck Terminate the thread if asked so */ static void yield(bool exitCheck = false); /** * Sleep for a number of seconds * @param sec Number of seconds to sleep * @param exitCheck Terminate the thread if asked so */ static void sleep(unsigned int sec, bool exitCheck = false); /** * Sleep for a number of milliseconds * @param msec Number of milliseconds to sleep * @param exitCheck Terminate the thread if asked so */ static void msleep(unsigned long msec, bool exitCheck = false); /** * Sleep for a number of microseconds * @param usec Number of microseconds to sleep, may be rounded to * milliseconds on some platforms * @param exitCheck Terminate the thread if asked so */ static void usleep(unsigned long usec, bool exitCheck = false); /** * Get a pointer to the currently running thread * @return A pointer to the current thread or NULL for the main thread * or threads created by other libraries */ static Thread* current(); /** * Get the number of Yate created threads * @return Count of current Thread objects */ static int count(); /** * Check if the current thread was asked to terminate. * @param exitNow If thread is marked as cancelled then terminate immediately * @return False if thread should continue running, true if it should stop */ static bool check(bool exitNow = true); /** * Terminates the current thread. */ static void exit(); /** * Terminates the specified thread. * @param hard Kill the thread the hard way rather than just setting an exit check marker */ void cancel(bool hard = false); /** * Check if this thread is the currently running thread * @return True if this is the current thread */ inline bool isCurrent() const { return current() == this; } /** * Convert a priority name to a thread priority level * @param name Name of the requested level * @param defvalue Priority to return in case of an invalid name * @return A thread priority level */ static Priority priority(const char* name, Priority defvalue = Normal); /** * Convert a priority level to a textual name * @param prio Priority level to convert * @return Name of the level or NULL if an invalid argument was provided */ static const char* priority(Priority prio); /** * Kills all other running threads. Ouch! * Must be called from the main thread or it does nothing. */ static void killall(); /** * On some platforms this method kills all other running threads. * Must be called after fork() but before any exec*() call. */ static void preExec(); protected: /** * Creates and starts a new thread * @param name Static name of the thread (for debugging purpose only) * @param prio Thread priority */ Thread(const char *name = 0, Priority prio = Normal); /** * Creates and starts a new thread * @param name Static name of the thread (for debugging purpose only) * @param prio Thread priority level name */ Thread(const char *name, const char* prio); /** * The destructor is called when the thread terminates */ virtual ~Thread(); private: ThreadPrivate* m_private; int m_locks; bool m_locking; }; class Socket; /** * Wrapper class to keep a socket address * @short A socket address holder */ class YATE_API SocketAddr : public GenObject { public: /** * Default constructor of an empty address */ inline SocketAddr() : m_address(0), m_length(0) { } /** * Copy constructor * @param value Address to copy */ inline SocketAddr(const SocketAddr& value) : m_address(0), m_length(0) { assign(value.address(),value.length()); } /** * Constructor of a null address * @param family Family of the address to create */ SocketAddr(int family); /** * Constructor that stores a copy of an address * @param addr Pointer to the address to store * @param len Length of the stored address, zero to use default */ SocketAddr(const struct sockaddr* addr, socklen_t len = 0); /** * Destructor that frees and zeroes out everything */ virtual ~SocketAddr(); /** * Assignment operator * @param value Address to copy */ inline SocketAddr& operator=(const SocketAddr& value) { assign(value.address(),value.length()); return *this; } /** * Equality comparation operator * @param other Address to compare to * @return True if the addresses are equal */ bool operator==(const SocketAddr& other) const; /** * Inequality comparation operator * @param other Address to compare to * @return True if the addresses are different */ inline bool operator!=(const SocketAddr& other) const { return !operator==(other); } /** * Clears up the address, frees the memory */ void clear(); /** * Assigns an empty address of a specific type * @param family Family of the address to create * @return True if the address family is supported */ bool assign(int family); /** * Assigns a new address * @param addr Pointer to the address to store * @param len Length of the stored address, zero to use default */ void assign(const struct sockaddr* addr, socklen_t len = 0); /** * Attempt to guess a local address that will be used to reach a remote one * @param remote Remote address to reach * @return True if guessed an address, false if failed */ bool local(const SocketAddr& remote); /** * Check if a non-null address is held * @return True if a valid address is held, false if null */ inline bool valid() const { return m_length && m_address; } /** * Check if a null address is held * @return True if a null address is held */ inline bool null() const { return !(m_length && m_address); } /** * Get the family of the stored address * @return Address family of the stored address or zero (AF_UNSPEC) */ inline int family() const { return m_address ? m_address->sa_family : 0; } /** * Get the host of this address * @return Host name as String */ inline const String& host() const { return m_host; } /** * Set the hostname of this address * @return True if new host set, false if name could not be parsed */ virtual bool host(const String& name); /** * Get the port of the stored address (if supported) * @return Port number of the socket address or zero */ int port() const; /** * Set the port of the stored address (if supported) * @param newport Port number to set in the socket address * @return True if new port set, false if not supported */ bool port(int newport); /** * Get the contained socket address * @return A pointer to the socket address */ inline struct sockaddr* address() const { return m_address; } /** * Get the length of the address * @return Length of the stored address */ inline socklen_t length() const { return m_length; } /** * Check if an address family is supported by the library * @param family Family of the address to check * @return True if the address family is supported */ static bool supports(int family); protected: /** * Convert the host address to a String stored in m_host */ virtual void stringify(); struct sockaddr* m_address; socklen_t m_length; String m_host; }; /** * Abstract interface for an object that filters socket received data packets * @short A filter for received socket data */ class YATE_API SocketFilter : public GenObject { friend class Socket; public: /** * Constructor */ SocketFilter(); /** * Destructor, unregisters from socket */ virtual ~SocketFilter(); /** * Get a pointer to a derived class given that class name * @param name Name of the class we are asking for * @return Pointer to the requested class or NULL if this object doesn't implement it */ virtual void* getObject(const String& name) const; /** * Run whatever actions required on idle thread runs * @param when Time when the idle run started */ virtual void timerTick(const Time& when); /** * Notify this filter about a received block of data * @param buffer Buffer for received data * @param length Length of the data in buffer * @param flags Operating system specific bit flags of the operation * @param addr Address of the incoming data, may be NULL * @param adrlen Length of the valid data in address structure * @return True if this filter claimed the data */ virtual bool received(void* buffer, int length, int flags, const struct sockaddr* addr, socklen_t adrlen) = 0; /** * Get the socket to which the filter is currently attached * @return Pointer to the socket of this filter */ inline Socket* socket() const { return m_socket; } /** * Check if the socket of this filter is valid * @return True if the filter has a valid socket */ bool valid() const; private: Socket* m_socket; }; /** * Base class for encapsulating system dependent stream capable objects * @short An abstract stream class capable of reading and writing */ class YATE_API Stream { public: /** * Destructor, terminates the stream */ virtual ~Stream(); /** * Get the error code of the last operation on this stream * @return Error code generated by the last operation on this stream */ inline int error() const { return m_error; } /** * Closes the stream * @return True if the stream was (already) closed, false if an error occured */ virtual bool terminate() = 0; /** * Check if the last error code indicates a retryable condition * @return True if error was temporary and operation should be retried */ virtual bool canRetry() const; /** * Check if this stream is valid * @return True if the stream is valid, false if it's invalid or closed */ virtual bool valid() const = 0; /** * Set the blocking or non-blocking operation mode of the stream * @param block True if I/O operations should block, false for non-blocking * @return True if operation was successfull, false if an error occured */ virtual bool setBlocking(bool block = true); /** * Write data to a connected stream * @param buffer Buffer for data transfer * @param length Length of the buffer * @return Number of bytes transferred, negative if an error occurred */ virtual int writeData(const void* buffer, int length) = 0; /** * Write a C string to a connected stream * @param str String to send over the stream * @return Number of bytes transferred, negative if an error occurred */ int writeData(const char* str); /** * Write a String to a connected stream * @param str String to send over the stream * @return Number of bytes transferred, negative if an error occurred */ inline int writeData(const String& str) { return writeData(str.c_str(), str.length()); } /** * Write a Data block to a connected stream * @param buf DataBlock to send over the stream * @return Number of bytes transferred, negative if an error occurred */ inline int writeData(const DataBlock& buf) { return writeData(buf.data(), buf.length()); } /** * Receive data from a connected stream * @param buffer Buffer for data transfer * @param length Length of the buffer * @return Number of bytes transferred, negative if an error occurred */ virtual int readData(void* buffer, int length) = 0; /** * Allocate a new pair of unidirectionally pipe connected streams * @param reader Reference of a pointer receiving the newly allocated reading side of the pipe * @param writer Reference of a pointer receiving the newly allocated writing side of the pipe * @return True is the stream pipe was created successfully */ static bool allocPipe(Stream*& reader, Stream*& writer); /** * Allocate a new pair of bidirectionally connected streams * @param str1 Reference of a pointer receiving the newly allocated 1st end of the pair * @param str2 Reference of a pointer receiving the newly allocated 2nd end of the pair * @return True is the stream pair was created successfully */ static bool allocPair(Stream*& str1, Stream*& str2); /** * Check if operating system supports unidirectional stream pairs * @return True if unidirectional pipes can be created */ static bool supportsPipes(); /** * Check if operating system supports bidirectional stream pairs * @return True if bidirectional pairs can be created */ static bool supportsPairs(); protected: /** * Default constructor */ inline Stream() : m_error(0) { } /** * Clear the last error code */ inline void clearError() { m_error = 0; } int m_error; }; /** * Class to encapsulate a system dependent file in a system independent abstraction * @short A stream file class */ class YATE_API File : public Stream { public: /** * Default constructor, creates a closed file */ File(); /** * Constructor from an existing handle * @param handle Operating system handle to an open file */ File(HANDLE handle); /** * Destructor, closes the file */ virtual ~File(); /** * Opens a file from the filesystem pathname * @param name Name of the file according to the operating system's conventions * @param canWrite Open the file for writing * @param canRead Open the file for reading * @param create Create the file if it doesn't exist * @param append Set the write pointer at the end of an existing file * @param binary Open the file in binary mode if applicable * @return True if the file was successfully opened */ virtual bool openPath(const char* name, bool canWrite = false, bool canRead = true, bool create = false, bool append = false, bool binary = false); /** * Closes the file handle * @return True if the file was (already) closed, false if an error occured */ virtual bool terminate(); /** * Attach an existing handle to the file, closes any existing first * @param handle Operating system handle to an open file */ void attach(HANDLE handle); /** * Detaches the object from the file handle * @return The handle previously owned by this object */ HANDLE detach(); /** * Get the operating system handle to the file * @return File handle */ inline HANDLE handle() const { return m_handle; } /** * Check if the last error code indicates a retryable condition * @return True if error was temporary and operation should be retried */ virtual bool canRetry() const; /** * Check if this file is valid * @return True if the file is valid, false if it's invalid or closed */ virtual bool valid() const; /** * Get the operating system specific handle value for an invalid file * @return Handle value for an invalid file */ static HANDLE invalidHandle(); /** * Set the blocking or non-blocking operation mode of the file * @param block True if I/O operations should block, false for non-blocking * @return True if operation was successfull, false if an error occured */ virtual bool setBlocking(bool block = true); /** * Find the length of the file if it has one * @return Length of the file or zero if length is not defined */ virtual unsigned int length(); /** * Write data to an open file * @param buffer Buffer for data transfer * @param length Length of the buffer * @return Number of bytes transferred, negative if an error occurred */ virtual int writeData(const void* buffer, int length); /** * Read data from an open file * @param buffer Buffer for data transfer * @param length Length of the buffer * @return Number of bytes transferred, negative if an error occurred */ virtual int readData(void* buffer, int length); /** * Deletes a file entry from the filesystem * @param name Absolute path and name of the file to delete * @return True if the file was successfully deleted */ static bool remove(const char* name); /** * Create a pair of unidirectionally pipe connected streams * @param reader Reference to a File that becomes the reading side of the pipe * @param writer Reference to a File that becomes the writing side of the pipe * @return True is the pipe was created successfully */ static bool createPipe(File& reader, File& writer); protected: /** * Copy the last error code from the operating system */ void copyError(); HANDLE m_handle; }; /** * This class encapsulates a system dependent socket in a system independent abstraction * @short A generic socket class */ class YATE_API Socket : public Stream { public: /** * Types of service */ enum TOS { LowDelay = IPTOS_LOWDELAY, MaxThroughput = IPTOS_THROUGHPUT, MaxReliability = IPTOS_RELIABILITY, MinCost = IPTOS_MINCOST, }; /** * Default constructor, creates an invalid socket */ Socket(); /** * Constructor from an existing handle * @param handle Operating system handle to an existing socket */ Socket(SOCKET handle); /** * Constructor that also creates the socket handle * @param domain Communication domain for the socket (protocol family) * @param type Type specification of the socket * @param protocol Specific protocol for the domain, 0 to use default */ Socket(int domain, int type, int protocol = 0); /** * Destructor - closes the handle if still open */ virtual ~Socket(); /** * Creates a new socket handle, * @param domain Communication domain for the socket (protocol family) * @param type Type specification of the socket * @param protocol Specific protocol for the domain, 0 to use default * @return True if socket was created, false if an error occured */ bool create(int domain, int type, int protocol = 0); /** * Closes the socket handle, terminates the connection * @return True if socket was (already) closed, false if an error occured */ virtual bool terminate(); /** * Attach an existing handle to the socket, closes any existing first * @param handle Operating system handle to an existing socket */ void attach(SOCKET handle); /** * Detaches the object from the socket handle * @return The handle previously owned by this object */ SOCKET detach(); /** * Get the operating system handle to the socket * @return Socket handle */ inline SOCKET handle() const { return m_handle; } /** * Check if the last error code indicates a retryable condition * @return True if error was temporary and operation should be retried */ virtual bool canRetry() const; /** * Check if this socket is valid * @return True if the handle is valid, false if it's invalid */ virtual bool valid() const; /** * Get the operating system specific handle value for an invalid socket * @return Handle value for an invalid socket */ static SOCKET invalidHandle(); /** * Get the operating system specific return value of a failed operation * @return Return value of a failed socket operation */ static int socketError(); /** * Set socket options * @param level Level of the option to set * @param name Socket option for which the value is to be set * @param value Pointer to a buffer holding the value for the requested option * @param length Size of the supplied buffer * @return True if operation was successfull, false if an error occured */ bool setOption(int level, int name, const void* value = 0, socklen_t length = 0); /** * Get socket options * @param level Level of the option to set * @param name Socket option for which the value is to be set * @param buffer Pointer to a buffer to return the value for the requested option * @param length Pointer to size of the supplied buffer, will be filled on return * @return True if operation was successfull, false if an error occured */ bool getOption(int level, int name, void* buffer, socklen_t* length); /** * Set the Type of Service on the IP level of this socket * @param tos New TOS bits to set * @return True if operation was successfull, false if an error occured */ bool setTOS(int tos); /** * Set the blocking or non-blocking operation mode of the socket * @param block True if I/O operations should block, false for non-blocking * @return True if operation was successfull, false if an error occured */ virtual bool setBlocking(bool block = true); /** * Set the local address+port reuse flag of the socket. * This method should be called before bind() or it will have no effect. * @param reuse True if other sockets may listen on same address+port * @param exclusive Grant exclusive access to the address * @return True if operation was successfull, false if an error occured */ bool setReuse(bool reuse = true, bool exclusive = false); /** * Set the way closing a socket is handled * @param seconds How much to block waiting for socket to close, * negative to no wait (close in background), zero to reset connection * @return True if operation was successfull, false if an error occured */ bool setLinger(int seconds = -1); /** * Associates the socket with a local address * @param addr Address to assign to this socket * @param addrlen Length of the address structure * @return True if operation was successfull, false if an error occured */ bool bind(struct sockaddr* addr, socklen_t addrlen); /** * Associates the socket with a local address * @param addr Address to assign to this socket * @return True if operation was successfull, false if an error occured */ inline bool bind(const SocketAddr& addr) { return bind(addr.address(), addr.length()); } /** * Start listening for incoming connections on the socket * @param backlog Maximum length of the queue of pending connections, 0 for system maximum * @return True if operation was successfull, false if an error occured */ bool listen(unsigned int backlog = 0); /** * Create a new socket for an incoming connection attempt on a listening socket * @param addr Address to fill in with the address of the incoming connection * @param addrlen Length of the address structure on input, length of address data on return * @return Open socket to the new connection or NULL on failure */ Socket* accept(struct sockaddr* addr = 0, socklen_t* addrlen = 0); /** * Create a new socket for an incoming connection attempt on a listening socket * @param addr Address to fill in with the address of the incoming connection * @return Open socket to the new connection or NULL on failure */ Socket* accept(SocketAddr& addr); /** * Create a new socket for an incoming connection attempt on a listening socket * @param addr Address to fill in with the address of the incoming connection * @param addrlen Length of the address structure on input, length of address data on return * @return Operating system handle to the new connection or @ref invalidHandle() on failure */ SOCKET acceptHandle(struct sockaddr* addr = 0, socklen_t* addrlen = 0); /** * Create a new socket by peeling off an association from a SCTP socket * @param assoc Identifier of the association to peel off * @return Open socket to the association or NULL on failure */ Socket* peelOff(unsigned int assoc); /** * Create a new socket by peeling off an association from a SCTP socket * @param assoc Identifier of the association to peel off * @return Operating system handle to the association or @ref invalidHandle() on failure */ SOCKET peelOffHandle(unsigned int assoc); /** * Connects the socket to a remote address * @param addr Address to connect to * @param addrlen Length of the address structure * @return True if operation was successfull, false if an error occured */ bool connect(struct sockaddr* addr, socklen_t addrlen); /** * Connects the socket to a remote address * @param addr Socket address to connect to * @return True if operation was successfull, false if an error occured */ inline bool connect(const SocketAddr& addr) { return connect(addr.address(), addr.length()); } /** * Shut down one or both directions of a full-duplex socket. * @param stopReads Request to shut down the read side of the socket * @param stopWrites Request to shut down the write side of the socket * @return True if operation was successfull, false if an error occured */ bool shutdown(bool stopReads, bool stopWrites); /** * Retrive the address of the local socket of a connection * @param addr Address to fill in with the address of the local socket * @param addrlen Length of the address structure on input, length of address data on return * @return True if operation was successfull, false if an error occured */ bool getSockName(struct sockaddr* addr, socklen_t* addrlen); /** * Retrive the address of the local socket of a connection * @param addr Address to fill in with the address of the local socket * @return True if operation was successfull, false if an error occured */ bool getSockName(SocketAddr& addr); /** * Retrive the address of the remote socket of a connection * @param addr Address to fill in with the address of the remote socket * @param addrlen Length of the address structure on input, length of address data on return * @return True if operation was successfull, false if an error occured */ bool getPeerName(struct sockaddr* addr, socklen_t* addrlen); /** * Retrive the address of the remote socket of a connection * @param addr Address to fill in with the address of the remote socket * @return True if operation was successfull, false if an error occured */ bool getPeerName(SocketAddr& addr); /** * Send a message over a connected or unconnected socket * @param buffer Buffer for data transfer * @param length Length of the buffer * @param addr Address to send the message to, if NULL will behave like @ref send() * @param adrlen Length of the address structure * @param flags Operating system specific bit flags that change the behaviour * @return Number of bytes transferred, @ref socketError() if an error occurred */ int sendTo(const void* buffer, int length, const struct sockaddr* addr, socklen_t adrlen, int flags = 0); /** * Send a message over a connected or unconnected socket * @param buffer Buffer for data transfer * @param length Length of the buffer * @param addr Address to send the message to * @param flags Operating system specific bit flags that change the behaviour * @return Number of bytes transferred, @ref socketError() if an error occurred */ inline int sendTo(const void* buffer, int length, const SocketAddr& addr, int flags = 0) { return sendTo(buffer, length, addr.address(), addr.length(), flags); } /** * Send a message over a connected socket * @param buffer Buffer for data transfer * @param length Length of the buffer * @param flags Operating system specific bit flags that change the behaviour * @return Number of bytes transferred, @ref socketError() if an error occurred */ int send(const void* buffer, int length, int flags = 0); /** * Write data to a connected stream socket * @param buffer Buffer for data transfer * @param length Length of the buffer * @return Number of bytes transferred, @ref socketError() if an error occurred */ virtual int writeData(const void* buffer, int length); /** * Receive a message from a connected or unconnected socket * @param buffer Buffer for data transfer * @param length Length of the buffer * @param addr Address to fill in with the address of the incoming data * @param adrlen Length of the address structure on input, length of address data on return * @param flags Operating system specific bit flags that change the behaviour * @return Number of bytes transferred, @ref socketError() if an error occurred */ int recvFrom(void* buffer, int length, struct sockaddr* addr = 0, socklen_t* adrlen = 0, int flags = 0); /** * Receive a message from a connected or unconnected socket * @param buffer Buffer for data transfer * @param length Length of the buffer * @param addr Address to fill in with the address of the incoming data * @param flags Operating system specific bit flags that change the behaviour * @return Number of bytes transferred, @ref socketError() if an error occurred */ int recvFrom(void* buffer, int length, SocketAddr& addr, int flags = 0); /** * Receive a message from a connected socket * @param buffer Buffer for data transfer * @param length Length of the buffer * @param flags Operating system specific bit flags that change the behaviour * @return Number of bytes transferred, @ref socketError() if an error occurred */ int recv(void* buffer, int length, int flags = 0); /** * Receive data from a connected stream socket * @param buffer Buffer for data transfer * @param length Length of the buffer * @return Number of bytes transferred, @ref socketError() if an error occurred */ virtual int readData(void* buffer, int length); /** * Determines the availability to perform synchronous I/O of the socket * @param readok Address of a boolean variable to fill with readability status * @param writeok Address of a boolean variable to fill with writeability status * @param except Address of a boolean variable to fill with exceptions status * @param timeout Maximum time until the method returns, NULL for blocking * @return True if operation was successfull, false if an error occured */ bool select(bool* readok, bool* writeok, bool* except, struct timeval* timeout = 0); /** * Determines the availability to perform synchronous I/O of the socket * @param readok Address of a boolean variable to fill with readability status * @param writeok Address of a boolean variable to fill with writeability status * @param except Address of a boolean variable to fill with exceptions status * @param timeout Maximum time until the method returns, -1 for blocking * @return True if operation was successfull, false if an error occured */ bool select(bool* readok, bool* writeok, bool* except, int64_t timeout); /** * Install a new packet filter in the socket * @param filter Pointer to the packet filter to install * @return True if the filter was installed */ bool installFilter(SocketFilter* filter); /** * Removes a packet filter and optionally destroys it * @param filter Pointer to the packet filter to remove from socket * @param delobj Set to true to also delete the filter */ void removeFilter(SocketFilter* filter, bool delobj = false); /** * Removes and destroys all packet filters */ void clearFilters(); /** * Run whatever actions required on idle thread runs. * The default implementation calls @ref SocketFilter::timerTick() * for all installed filters. * @param when Time when the idle run started */ virtual void timerTick(const Time& when); /** * Create a pair of bidirectionally connected sockets * @param sock1 Reference to first Socket to be paired * @param sock2 Reference to second Socket to be paired * @param domain Communication domain for the sockets (protocol family) * @return True is the stream pair was created successfully */ static bool createPair(Socket& sock1, Socket& sock2, int domain = AF_UNIX); protected: /** * Copy the last error code from the operating system */ void copyError(); /** * Copy the last error code from the operating system if an error occured, clear if not * @param retcode Operation return code to check, 0 for success * @param strict True to consider errors only return codes of @ref socketError() * @return True if operation succeeded (retcode == 0), false otherwise */ bool checkError(int retcode, bool strict = false); /** * Apply installed filters to a received block of data * @param buffer Buffer for received data * @param length Length of the data in buffer * @param flags Operating system specific bit flags of the operation * @param addr Address of the incoming data, may be NULL * @param adrlen Length of the valid data in address structure * @return True if one of the filters claimed the data */ bool applyFilters(void* buffer, int length, int flags, const struct sockaddr* addr = 0, socklen_t adrlen = 0); SOCKET m_handle; ObjList m_filters; }; /** * The SysUsage class allows collecting some statistics about engine's usage * of system resources * @short A class exposing system resources usage */ class YATE_API SysUsage { public: /** * Type of time usage requested */ enum Type { WallTime, UserTime, KernelTime }; /** * Initialize the system start variable */ static void init(); /** * Get the wall time used as start for the usage time * @return Time of the first direct or implicit call of @ref init() */ static u_int64_t startTime(); /** * Get the program's running time in microseconds * @param type Type of running time requested * @return Time in microseconds since the start of the program */ static u_int64_t usecRunTime(Type type = WallTime); /** * Get the program's running time in milliseconds * @param type Type of running time requested * @return Time in milliseconds since the start of the program */ static u_int64_t msecRunTime(Type type = WallTime); /** * Get the program's running time in seconds * @param type Type of running time requested * @return Time in seconds since the start of the program */ static u_int32_t secRunTime(Type type = WallTime); /** * Get the program's running time in seconds * @param type Type of running time requested * @return Time in seconds since the start of the program */ static double runTime(Type type = WallTime); }; }; // namespace TelEngine #endif /* __YATECLASS_H */ /* vi: set ts=8 sw=4 sts=4 noet: */