class ChanAssistList

Class keeping a list of ChanAssist objects. More...

Contains pure virtuals
Full nameTelEngine::ChanAssistList
Definition#include <contrib/ypbx/yatepbx.h>
InheritsTelEngine::Module [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods

Protected Methods


Detailed Description

Class keeping a list of ChanAssist objects. It also serves as base to implement channel assisting plugins.

enum { Startup = Private, Hangup, Disconnected, AssistPrivate }

Message realy IDs

 ~ChanAssistList ()

~ChanAssistList

[virtual]

Destructor

bool  received (Message& msg, int id)

received

[virtual]

Message handler called internally

Parameters:
msgReceived nessage
idNumeric identifier of the message type

Returns: True if the message was handled and further processing should stop

Reimplemented from Module.

bool  received (Message& msg, int id, ChanAssist* assist)

received

[virtual]

Message handler for an assistant object

Parameters:
msgReceived nessage
idNumeric identifier of the message type
assistPointer to the matching assistant object

Returns: True if the message was handled and further processing should stop

Reimplemented from Module.

void  initialize ()

initialize

[virtual]

Method to (re)initialize the plugin

Reimplemented from Module.

ChanAssist*  create (Message& msg, const String& id)

create

[pure virtual]

Create a new channel assistant

Parameters:
msgMessage that triggered the creation
idChannel's identifier

Returns: Pointer to new assistant object, NULL if unacceptable

void  init (int priority = 15)

init

[virtual]

Initialize the plugin for the first time

Parameters:
priorityPriority used to install message handlers

inline ChanAssist*  find (const String& id)

find

[const]

Find a channel assistant by channel ID

Parameters:
idIdentifier of the assisted channel

Returns: Pointer to the assistant object

inline  ChanAssistList (const char* name)

ChanAssistList

[protected]

Constructor

Parameters:
nameName of the module

void  removeAssist (ChanAssist* assist)

removeAssist

[protected]

Removes an assistant object from list

Parameters:
assistObject to remove from list


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