ChanAssist Class Reference

#include <yatepbx.h>

Inheritance diagram for ChanAssist:

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
Public Member Functions inherited from RefObject
	RefObject ()
virtual	~RefObject ()
virtual void *	getObject (const String &name) const
virtual bool	alive () const
bool	ref ()
bool	deref ()
int	refcount () const
virtual void	destruct ()
Public Member Functions inherited from GenObject
	GenObject ()
virtual	~GenObject ()
virtual const String &	traceId () const
NamedCounter *	getObjCounter () const
NamedCounter *	setObjCounter (NamedCounter *counter)

Static Public Member Functions
static RefPointer< CallEndpoint >	locate (const String &id)
Static Public Member Functions inherited from RefObject
static bool	alive (const RefObject *obj)
static bool	efficientIncDec ()
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 ()

Protected Member Functions
	ChanAssist (ChanAssistList *list, const String &id)
Protected Member Functions inherited from RefObject
virtual void	zeroRefs ()
bool	resurrect ()
virtual void	destroyed ()

Detailed Description

Object that assists a channel

Constructor & Destructor Documentation

~ChanAssist()

virtual ~ChanAssist ( )

virtual

Destructor

ChanAssist()

ChanAssist ( ChanAssistList * list, const String & id )

inlineprotected

Constructor of base class

Parameters

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

References id(), and list().

Member Function Documentation

id()

const String & id ( ) const

inline

Get the name of the assisted channel

Returns

Identifier of the channel

Referenced by ChanAssist().

list()

ChanAssistList * list ( ) const

inline

Retrieve the list that owns this object

Returns

Pointer to the owner list

Referenced by ChanAssist().

locate() [1/2]

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 locate().

locate() [2/2]

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

Referenced by locate().

msgDisconnect()

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

msgExecute()

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

msgHangup()

virtual void msgHangup ( Message & msg )

virtual

Process the chan.hangup message

Parameters

msg	Last channel message

msgStartup()

virtual void msgStartup ( Message & msg )

virtual

Process the chan.startup message

Parameters

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

toString()

virtual const String & toString ( ) const

inlinevirtual

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