class Module

A Plugin that implements a module. More...

Full nameTelEngine::Module
Definition#include <yatephone.h>
InheritsTelEngine::DebugEnabler [public ], TelEngine::MessageReceiver [public ], TelEngine::Mutex [public ], TelEngine::Plugin [public ]
Inherited byChanAssistList, ClientDriver, Driver
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Static Methods

Protected Types

Protected Methods

Protected Static Methods


Detailed Description

Module is a descendent of Plugin specialized in implementing modules

void*  getObject (const String& name)

getObject

[const virtual]

Get a pointer to a derived class given that class name

Parameters:
nameName of the class we are asking for

Returns: Pointer to the requested class or NULL if this object doesn't implement it

Reimplemented from Plugin.

inline const String&  name ()

name

[const]

Retrive the name of the module

Returns: The module's name as String

inline const String&  type ()

type

[const]

Retrive the type of the module

Returns: The module's type as String

void  changed ()

changed

Mark the driver statistics "dirty" therefore triggring a delayed status update.

inline unsigned int  updateDelay ()

updateDelay

[static]

Retrive the global update notification delay

Returns: Update delay value in seconds

inline void  updateDelay (unsigned int delay)

updateDelay

[static]

Set the global update notification delay

Parameters:
delayNew update delay value in seconds, 0 to disable

inline bool  filterInstalled ()

filterInstalled

[const]

Check if a debug filter is installed

Returns: True if debugging should be filtered

bool  filterDebug (const String& item)

filterDebug

[const]

Check by filter rule if debugging should be active

Parameters:
itemValue of the item to match

Returns: True if debugging should be activated

enum { Status = 0x00000001, Timer = 0x00000002, Level = 0x00000004, Command = 0x00000008, Help = 0x00000010, Halt = 0x00000020, Route = 0x00000040, Execute = 0x00000100, Drop = 0x00000200, Locate = 0x00000400, Masquerade = 0x00000800, Ringing = 0x00001000, Answered = 0x00002000, Tone = 0x00004000, Text = 0x00008000, Progress = 0x00010000, Update = 0x00020000, Transfer = 0x00040000, PubLast = 0x0fffffff, Private = 0x10000000 }

[protected]

IDs of the installed relays

const char*  messageName (int id)

messageName

[protected static]

Find the name of a specific Relay ID

Parameters:
idRelayID of the message

Returns: Pointer to name of the message or NULL if not found

 Module (const char* name, const char* type = 0)

Module

[protected]

Constructor

Parameters:
namePlugin name of this driver
typeType of the driver: "misc", "route", etc.

 ~Module ()

~Module

[protected virtual]

Destructor

void  initialize ()

initialize

[protected virtual]

This method is called to initialize the loaded module

Reimplemented from Plugin.

void  setup ()

setup

[protected]

Install standard message relays

bool  installRelay (int id, unsigned priority = 100)

installRelay

[protected]

Install a standard message relay

Parameters:
idRelayID of the new relay to create
priorityPriority of the handler, 0 = top

Returns: True if installed or already was one installed

bool  installRelay (const char* name, unsigned priority = 100)

installRelay

[protected]

Install a standard message relay

Parameters:
nameName of the relay to create, must match a RelayID
priorityPriority of the handler, 0 = top

Returns: True if installed or already was one installed

bool  received (Message &msg, int id)

received

[protected virtual]

Message receiver handler

Parameters:
msgThe received message
idThe identifier with which the relay was created

Returns: True to stop processing, false to try other handlers

Reimplemented from MessageReceiver.

void  genUpdate (Message& msg)

genUpdate

[protected virtual]

Opportunity to modify the update message

Parameters:
msgStatus update message

void  msgTimer (Message& msg)

msgTimer

[protected virtual]

Timer message handler.

Parameters:
msgTime message

void  msgStatus (Message& msg)

msgStatus

[protected virtual]

Status message handler that is invoked only for matching messages.

Parameters:
msgStatus message

bool  msgRoute (Message& msg)

msgRoute

[protected virtual]

Routing message handler that is invoked for all call.route messages.

Parameters:
msgCall routing message

Returns: True to stop processing the message, false to try other handlers

bool  msgCommand (Message& msg)

msgCommand

[protected virtual]

Handler for special commands and line completion requests. By default it calls commandExecute() or commandComplete().

Parameters:
msgCommand message

Returns: True to stop processing the message, false to try other handlers

void  statusModule (String& str)

statusModule

[protected virtual]

Build the module identification part of the status answer

Parameters:
strString variable to fill up

void  statusParams (String& str)

statusParams

[protected virtual]

Build the parameter reporting part of the status answer

Parameters:
strString variable to fill up

void  statusDetail (String& str)

statusDetail

[protected virtual]

Build the details reporting part of the status answer

Parameters:
strString variable to fill up

bool  commandExecute (String& retVal, const String& line)

commandExecute

[protected virtual]

Execute a specific command

Parameters:
retValString to append the textual command output to
lineCommand line to attempt to execute

Returns: True to stop processing the message, false to try other handlers

bool  commandComplete (Message& msg, const String& partLine, const String& partWord)

commandComplete

[protected virtual]

Complete a command line

Parameters:
msgMessage to return completion into
partLinePartial line to complete, excluding the last word
partWordPartial word to complete

Returns: True to stop processing the message, false to try other handlers

bool  setDebug (Message& msg, const String& target)

setDebug

[protected virtual]

Set the local debugging level

Parameters:
msgDebug setting message
targetString to match for local settings


Generated by: root on dragoshel on Sat Apr 14 01:50:50 2007, using kdoc 2.0a54.