#include <PtAddress.h>

Collaboration diagram for PtAddress:

[legend]

Public Member Functions
	PtAddress ()

	PtAddress (TaoClientTask pClient, const char name)

	PtAddress (PtProvider pProvider, const char address)

	PtAddress (const PtAddress &rPtAddress)

	PtAddress (const char *address)

virtual	~PtAddress ()

PtAddress &	operator= (const PtAddress &rhs)

virtual PtStatus	addAddressListener (PtAddressListener &rAddressListener)

virtual PtStatus	addCallListener (PtCallListener &rCallListener)
	param: (in) rAddressListener - The listener to add to this address retcode: PT_SUCCESS - Success retcode: PT_EXISTS - rAddressListener is already registered retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	cancelForwarding (void)
	param: (in) rCallListener - The listener to add to calls associated with this address retcode: PT_SUCCESS - Success retcode: PT_EXISTS - rCallListener is already registered retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	cancelForwarding (PtAddressForwarding forwards[], int size)
	retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	removeCallListener (PtCallListener &rCallListener)
	param: (in) forwards - the forwarding instructions to remove param: (in) size - the number of forwarding instructions to remove retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	removeAddressListener (PtAddressListener &rAddressListener)
	param: (in) rCallListener - the listener to remove retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - rCallListener not registered retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available More...

virtual PtStatus	setDoNotDisturb (PtBoolean flag)
	param: (in) rAddressListener - the listener to remove from this address retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - rAddressListener not registered retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available More...

virtual PtStatus	setForwarding (PtAddressForwarding forwards[], int size)
	param: (in) flag - TRUE ==> enable, FALSE ==> disable retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available More...

virtual PtStatus	setMessageWaiting (PtBoolean flag)
	param: (in) forwards - the array of call forwarding instructions param: (in) size - the number of forwarding instructions in the forwards array retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available More...

virtual PtStatus	setOfferedTimeout (int milliSecs)
	param: (in) flag - TRUE ==> on, FALSE ==> off retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available More...

virtual PtStatus	getAddressListeners (PtAddressListener *addrListeners[], int size, int &nItems)
	param: (in) milliSecs - number of milliseconds to delay retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available More...

virtual PtStatus	getCallListeners (PtCallListener *callListeners[], int size, int &nItems)
	param: (out) addrListeners - the array of pointers to known address listeners param: (in) size - the number of elements in the addrListeners array param: (out) nItems - the number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - there are more than size listeners retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available More...

virtual PtStatus	getConnections (PtConnection connections[], int size, int &nItems)
	param: (out) callListeners - the array of pointers to known call listeners param: (in) size - the number of elements in the callListeners array param: (out) nItems - the number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - there are more than size listeners retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available More...

virtual PtStatus	getDoNotDisturb (PtBoolean &rFlag)
	param: (out) connections - the array of PtConnection pointers param: (in) size - the number of elements in the connections array param: (out) nItems - the number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - there are more than size connections retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	getForwarding (PtAddressForwarding forwards[], int size, int &nItems)
	param: (out) rFlag - TRUE ==> enabled, FALSE ==> disabled retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	getMessageWaiting (PtBoolean &rFlag)
	param: (out) forwards - The array of PtAddressForwarding objects param: (in) size - The number of elements in the forwards array param: (out) nItems - The number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - There are more than size forwards retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

PtStatus	getName (char *rpName, int len)
	param: (out) rFlag - TRUE ==> on, FALSE ==> off retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	getOfferedTimeout (int &rMilliSecs)
	param: (out) rpName - The reference used to return the name retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	getProvider (PtProvider &rpProvider)
	param: (out) rMilliSecs - Set to the offered timeout value retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	getTerminals (PtTerminal terms[], int size, int &nItems)
	param: (out) rpProvider - a pointer to the PtProvider object associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	numAddressListeners (int &count)
	param: (out) terms - The array of PtTerminal pointers param: (in) size - The number of elements in the terms array param: (out) nItems - The number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - There are more than size terminals retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	numCallListeners (int &count)
	param: (out) count - The number of address listeners associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	numConnections (int &count)
	param: (out) count - The number of call listeners associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	numForwards (int &count)
	param: (out) count - The number of connections associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

virtual PtStatus	numTerminals (int &count)
	param: (out) count - The number of forwarding instructions associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

Protected Member Functions
void	initialize ()

Protected Attributes
TaoClientTask *	mpClient

UtlString	mAddress

OsTime	mTimeOut

Static Protected Attributes
static OsBSem	semInit
	param: (out) count - The number of terminals associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...

static TaoReference *	mpTransactionCnt = 0

static unsigned int	mRef = 0

Private Attributes
OsProtectEventMgr *	mpEventMgr

TaoReference *	mpAddressListenerCnt

TaoObjectMap *	mpAddressListenerDb

Static Private Attributes
static OsBSem	mAddressForwardDbSem

static PtAddressForwarding *	mpAddressForwards = 0

static int	mAddressForwardCnt = 0

static PtBoolean	mbMessageWaiting = FALSE

static PtBoolean	mbDoNotDisturb = FALSE

static PtBoolean	mOfferedTimeout = 0

Constructor & Destructor Documentation

PtAddress ( )

PtAddress	(	TaoClientTask *	pClient,
		const char *	name
	)

PtAddress	(	PtProvider *	pProvider,
		const char *	address
	)

PtAddress ( const PtAddress & rPtAddress )

PtAddress ( const char * address )

~PtAddress ( )

virtual

Member Function Documentation

PtStatus addAddressListener ( PtAddressListener & rAddressListener )

virtual

PtStatus addCallListener ( PtCallListener & rCallListener )

virtual

param: (in) rAddressListener - The listener to add to this address retcode: PT_SUCCESS - Success retcode: PT_EXISTS - rAddressListener is already registered retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus cancelForwarding ( void )

virtual

param: (in) rCallListener - The listener to add to calls associated with this address retcode: PT_SUCCESS - Success retcode: PT_EXISTS - rCallListener is already registered retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus cancelForwarding	(	PtAddressForwarding	forwards[],
		int	size
	)

virtual

retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getAddressListeners	(	PtAddressListener *	addrListeners[],
		int	size,
		int &	nItems
	)

virtual

param: (in) milliSecs - number of milliseconds to delay retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

PtStatus getCallListeners	(	PtCallListener *	callListeners[],
		int	size,
		int &	nItems
	)

virtual

param: (out) addrListeners - the array of pointers to known address listeners param: (in) size - the number of elements in the addrListeners array param: (out) nItems - the number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - there are more than size listeners retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

PtStatus getConnections	(	PtConnection	connections[],
		int	size,
		int &	nItems
	)

virtual

param: (out) callListeners - the array of pointers to known call listeners param: (in) size - the number of elements in the callListeners array param: (out) nItems - the number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - there are more than size listeners retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

PtStatus getDoNotDisturb ( PtBoolean & rFlag )

virtual

param: (out) connections - the array of PtConnection pointers param: (in) size - the number of elements in the connections array param: (out) nItems - the number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - there are more than size connections retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getForwarding	(	PtAddressForwarding	forwards[],
		int	size,
		int &	nItems
	)

virtual

param: (out) rFlag - TRUE ==> enabled, FALSE ==> disabled retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getMessageWaiting ( PtBoolean & rFlag )

virtual

param: (out) forwards - The array of PtAddressForwarding objects param: (in) size - The number of elements in the forwards array param: (out) nItems - The number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - There are more than size forwards retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getName	(	char *	rpName,
		int	len
	)

param: (out) rFlag - TRUE ==> on, FALSE ==> off retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getOfferedTimeout ( int & rMilliSecs )

virtual

param: (out) rpName - The reference used to return the name retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getProvider ( PtProvider & rpProvider )

virtual

param: (out) rMilliSecs - Set to the offered timeout value retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus getTerminals	(	PtTerminal	terms[],
		int	size,
		int &	nItems
	)

virtual

param: (out) rpProvider - a pointer to the PtProvider object associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

void initialize ( )

protected

PtStatus numAddressListeners ( int & count )

virtual

param: (out) terms - The array of PtTerminal pointers param: (in) size - The number of elements in the terms array param: (out) nItems - The number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - There are more than size terminals retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus numCallListeners ( int & count )

virtual

param: (out) count - The number of address listeners associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus numConnections ( int & count )

virtual

param: (out) count - The number of call listeners associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus numForwards ( int & count )

virtual

param: (out) count - The number of connections associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus numTerminals ( int & count )

virtual

param: (out) count - The number of forwarding instructions associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtAddress & operator= ( const PtAddress & rhs )

PtStatus removeAddressListener ( PtAddressListener & rAddressListener )

virtual

param: (in) rCallListener - the listener to remove retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - rCallListener not registered retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

PtStatus removeCallListener ( PtCallListener & rCallListener )

virtual

param: (in) forwards - the forwarding instructions to remove param: (in) size - the number of forwarding instructions to remove retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtStatus setDoNotDisturb ( PtBoolean flag )

virtual

param: (in) rAddressListener - the listener to remove from this address retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - rAddressListener not registered retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

PtStatus setForwarding	(	PtAddressForwarding	forwards[],
		int	size
	)

virtual

param: (in) flag - TRUE ==> enable, FALSE ==> disable retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

PtStatus setMessageWaiting ( PtBoolean flag )

virtual

param: (in) forwards - the array of call forwarding instructions param: (in) size - the number of forwarding instructions in the forwards array retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

PtStatus setOfferedTimeout ( int milliSecs )

virtual

param: (in) flag - TRUE ==> on, FALSE ==> off retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - the provider is not available

Member Data Documentation

UtlString mAddress

protected

int mAddressForwardCnt = 0

staticprivate

OsBSem mAddressForwardDbSem

staticprivate

PtBoolean mbDoNotDisturb = FALSE

staticprivate

PtBoolean mbMessageWaiting = FALSE

staticprivate

int mOfferedTimeout = 0

staticprivate

PtAddressForwarding * mpAddressForwards = 0

staticprivate

TaoReference* mpAddressListenerCnt

private

TaoObjectMap* mpAddressListenerDb

private

TaoClientTask* mpClient

protected

OsProtectEventMgr* mpEventMgr

private

TaoReference * mpTransactionCnt = 0

staticprotected

unsigned int mRef = 0

staticprotected

OsTime mTimeOut

protected

OsBSem semInit

staticprotected

param: (out) count - The number of terminals associated with this address retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

sipXcallLib home page

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Static Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation