ChanAssist Class Reference

#include <yatepbx.h>

Inheritance diagram for ChanAssist:

List of all members.

Public Member Functions
virtual	~ChanAssist ()
virtual const String &	toString () const
virtual void	msgStartup (Message &msg)
virtual void	msgHangup (Message &msg)
virtual void	msgExecute (Message &msg)
virtual bool	msgDisconnect (Message &msg, const String &reason)
ChanAssistList *	list () const
const String &	id () const
RefPointer< CallEndpoint >	locate () const
Static Public Member Functions
static RefPointer< CallEndpoint >	locate (const String &id)
Protected Member Functions
	ChanAssist (ChanAssistList *list, const String &id)

---

Detailed Description

Object that assists a channel

---

Constructor & Destructor Documentation

virtual ~ChanAssist

(

)

[virtual]

Destructor

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

Constructor of base class

Parameters:

list	ChanAssistList that owns this object
id	Identifier of the assisted channel

---

Member Function Documentation

const String& id

(

)

const [inline]

Get the name of the assisted channel

Returns:

Identifier of the channel

ChanAssistList* list

(

)

const [inline]

Retrieve the list that owns this object

Returns:

Pointer to the owner list

static RefPointer<CallEndpoint> locate

(

const String &

id

)

[static]

Retrieve a smart pointer to an arbitrary channel

Parameters:

id	Identifier of the channel to locate

Returns:

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

RefPointer<CallEndpoint> locate

(

)

const [inline]

Retrieve a smart pointer to the assisted channel

Returns:

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

References ChanAssist::locate().

Referenced by ChanAssist::locate().

virtual bool msgDisconnect	(	Message &	msg,
		const String &	reason
	)		[virtual]

Process the channel disconnect message, may connect to something else

Parameters:

msg	The chan.disconnected message
reason	The disconnection reason

virtual void msgExecute

(

Message &

msg

)

[virtual]

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

Parameters:

msg	Call execute message, may be received before chan.startup

virtual void msgHangup

(

Message &

msg

)

[virtual]

Process the chan.hangup message

Parameters:

msg	Last channel message

virtual void msgStartup

(

Message &

msg

)

[virtual]

Process the chan.startup message

Parameters:

msg	First channel message, may be received after call.execute

virtual const String& toString

(

)

const [inline, virtual]

Get the String value of this object

Returns:

ID of the assisted channel

Reimplemented from GenObject.

---

The documentation for this class was generated from the following file:

• yatepbx.h