A Plugin that implements a module. More...
#include <yatephone.h>
Public Member Functions | |
| virtual void * | getObject (const String &name) const |
| const String & | type () const |
| void | changed () |
| bool | filterInstalled () const |
| bool | filterDebug (const String &item) const |
 Public Member Functions inherited from Plugin | |
| Plugin (const char *name, bool earlyInit=false) | |
| virtual | ~Plugin () |
| virtual const String & | toString () const |
| virtual bool | isBusy () const |
| const String & | name () const |
| NamedCounter * | objectsCounter () const |
| bool | earlyInit () const |
| Public Member Functions inherited from GenObject | |
| GenObject () | |
| virtual | ~GenObject () |
| virtual bool | alive () const |
| virtual void | destruct () |
| virtual const String & | traceId () const |
| NamedCounter * | getObjCounter () const |
| NamedCounter * | setObjCounter (NamedCounter *counter) |
| Public Member Functions inherited from DebugEnabler | |
| DebugEnabler (int level=TelEngine::debugLevel(), bool enabled=true) | |
| int | debugLevel () const |
| int | debugLevel (int level) |
| bool | debugEnabled () const |
| void | debugEnabled (bool enable) |
| const char * | debugName () const |
| bool | debugAt (int level) const |
| bool | debugChained () const |
| void | debugChain (const DebugEnabler *chain=0) |
| void | debugCopy (const DebugEnabler *original=0) |
| Public Member Functions inherited from Mutex | |
| Mutex (bool recursive=false, const char *name=0) | |
| Mutex (const Mutex &original) | |
| ~Mutex () | |
| Mutex & | operator= (const Mutex &original) |
| virtual bool | lock (long maxwait=-1) |
| virtual bool | unlock () |
| virtual bool | locked () const |
| const char * | owner () const |
| bool | recursive () const |
| Public Member Functions inherited from Lockable | |
| virtual | ~Lockable () |
| virtual bool | check (long maxwait=-1) |
| virtual bool | unlockAll () |
Static Public Member Functions | |
| static unsigned int | updateDelay () |
| static void | updateDelay (unsigned int delay) |
| static bool | itemComplete (String &itemList, const String &item, const String &partWord) |
| Static Public Member Functions inherited from GenObject | |
| static void * | getObject (const String &name, const GenObject *obj) |
| static bool | getObjCounting () |
| static void | setObjCounting (bool enable) |
| static NamedCounter * | getObjCounter (const String &name, bool create=true) |
| static ObjList & | getObjCounters () |
| Static Public Member Functions inherited from Mutex | |
| static int | count () |
| static int | locks () |
| static bool | efficientTimedLock () |
| Static Public Member Functions inherited from Lockable | |
| static void | wait (unsigned long maxwait) |
| static unsigned long | wait () |
| static void | startUsingNow () |
| static void | enableSafety (bool safe=true) |
| static bool | safety () |
Static Protected Member Functions | |
| static const char * | messageName (int id) |
| static int | relayId (const char *name) |
Protected Attributes | |
| enum TelEngine::Module:: { ... } | RelayID |
Detailed Description
A Plugin that implements a module.
Module is a descendent of Plugin specialized in implementing modules
Member Enumeration Documentation
◆ anonymous enum
Constructor & Destructor Documentation
◆ Module()
Constructor
- Parameters
-
name Plugin name of this driver type Type of the driver: "misc", "route", etc. earlyInit True to attempt to initialize module before others
◆ ~Module()
Member Function Documentation
◆ changed()
| void changed | ( | ) |
Mark the driver statistics "dirty" therefore triggring a delayed status update.
◆ commandComplete()
◆ commandExecute()
Execute a specific command
- Parameters
-
retVal String to append the textual command output to line Command line to attempt to execute
- Returns
- True to stop processing the message, false to try other handlers
◆ filterDebug()
Check by filter rule if debugging should be active
- Parameters
-
item Value of the item to match
- Returns
- True if debugging should be activated
◆ filterInstalled()
|
inline |
Check if a debug filter is installed
- Returns
- True if debugging should be filtered
References String::null().
◆ genUpdate()
Opportunity to modify the update message
- Parameters
-
msg Status update message
Reimplemented in Driver.
◆ getObject()
◆ initialize()
This method is called to initialize the loaded module
Implements Plugin.
Reimplemented in Driver, and ClientDriver.
◆ installRelay() [1/4]
Install a standard message relay
- Parameters
-
name Name of the relay to create, must match a RelayID priority Priority of the handler, 0 = top
- Returns
- True if installed or already was one installed
◆ installRelay() [2/4]
Install a custom message relay
- Parameters
-
id RelayID of the new relay to create name Name of the custom relay to create priority Priority of the handler, 0 = top
- Returns
- True if installed or already was one installed
◆ installRelay() [3/4]
Install a standard message relay
- Parameters
-
id RelayID of the new relay to create priority Priority of the handler, 0 = top
- Returns
- True if installed or already was one installed
◆ installRelay() [4/4]
|
protected |
Install a custom message relay
- Parameters
-
relay Custom message relay
- Returns
- True if installed, false if there was already one with same ID
◆ itemComplete()
Helper function to complete just one item on a command line
- Parameters
-
itemList Tab separated list of possible values to complete item Item to possibly insert in the list partWord Partial word to complete, may be empty
- Returns
- True if the item was added to list, false if it didn't match
◆ messageName()
Find the name of a specific Relay ID
- Parameters
-
id RelayID of the message
- Returns
- Pointer to name of the message or NULL if not found
◆ msgCommand()
Handler for special commands and line completion requests. By default it calls commandExecute() or commandComplete().
- Parameters
-
msg Command message
- Returns
- True to stop processing the message, false to try other handlers
◆ msgRoute()
Routing message handler that is invoked for all call.route messages.
- Parameters
-
msg Call routing message
- Returns
- True to stop processing the message, false to try other handlers
Reimplemented in ClientDriver, and Driver.
◆ msgStatus()
Status message handler that is invoked only for matching messages.
- Parameters
-
msg Status message
◆ msgTimer()
◆ received()
Message receiver handler
- Parameters
-
msg The received message id The identifier with which the relay was created
- Returns
- True to stop processing, false to try other handlers
Implements MessageReceiver.
Reimplemented in ClientDriver, and Driver.
◆ relayId()
Find the ID or a specific Relay name
- Parameters
-
name Name of the Relay to search for
- Returns
- ID of the Relay, zero if not found
References Plugin::name().
◆ relayInstalled()
Check if a specific relay ID is installed
- Parameters
-
id RelayID to test for
- Returns
- True if such a relay is installed
◆ setDebug()
◆ setup()
|
protected |
Install standard message relays
◆ statusDetail()
◆ statusModule()
◆ statusParams()
◆ type()
Retrieve the type of the module
- Returns
- The module's type as String
◆ uninstallRelay() [1/2]
Uninstall a message relay
- Parameters
-
id RelayID to uninstall, relay will be deleted delRelay True to delete the relay after removing it
- Returns
- True if uninstalled, false if if was not present
◆ uninstallRelay() [2/2]
|
protected |
Uninstall a message relay
- Parameters
-
relay Pointer to message relay delRelay True to delete the relay after removing it
- Returns
- True if uninstalled, false if if was not present
◆ uninstallRelays()
|
protected |
Uninstall all installed relays in preparation for unloading
- Returns
- True if all relays were uninstalled, false if something wrong
◆ updateDelay() [1/2]
Retrieve the global update notification delay
- Returns
- Update delay value in seconds
◆ updateDelay() [2/2]
Set the global update notification delay
- Parameters
-
delay New update delay value in seconds, 0 to disable
Member Data Documentation
◆ []
| enum { ... } RelayID |
IDs of the installed relays
The documentation for this class was generated from the following file:
