class ChanAssist

Object that assists a channel More...

Full nameTelEngine::ChanAssist
Definition#include <contrib/ypbx/yatepbx.h>
InheritsTelEngine::RefObject [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Static Methods

Protected Methods


Detailed Description

Object that assists a channel

 ~ChanAssist ()

~ChanAssist

[virtual]

Destructor

const String&  toString ()

toString

[const virtual]

Get the String value of this object

Returns: ID of the assisted channel

Reimplemented from GenObject.

void  msgStartup (Message& msg)

msgStartup

[virtual]

Process the chan.startup message

Parameters:
msgFirst channel message

void  msgHangup (Message& msg)

msgHangup

[virtual]

Process the chan.hangup message

Parameters:
msgLast channel message

void  msgExecute (Message& msg)

msgExecute

[virtual]

Process the call.execute message, copy any parameters needed later

Parameters:
msgCall execute message

bool  msgDisconnect (Message& msg, const String& reason)

msgDisconnect

[virtual]

Process the channel disconnect message, may connect to something else

Parameters:
msgThe chan.disconnected message
reasonThe disconnection reason

inline ChanAssistList*  list ()

list

[const]

Retrive the list that owns this object

Returns: Pointer to the owner list

inline const String&  id ()

id

[const]

Get the name of the assisted channel

Returns: Identifier of the channel

RefPointer  locate (const String& id)

locate

[static]

Retrive a smart pointer to an arbitrary channel

Parameters:
idIdentifier of the channel to locate

Returns: Smart pointer to the channel or NULL if not found or dead

inline RefPointer  locate ()

locate

[const]

Retrive a smart pointer to the assisted channel

Returns: Smart pointer to the channel or NULL if not found or dead

inline  ChanAssist (ChanAssistList* list, const String& id)

ChanAssist

[protected]

Constructor of base class

Parameters:
listChanAssistList that owns this object
idIdentifier of the assisted channel


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