TaoPhoneComponentAdaptor Class Reference

#include <TaoPhoneComponentAdaptor.h>

Inheritance diagram for TaoPhoneComponentAdaptor:

Collaboration diagram for TaoPhoneComponentAdaptor:

Public Member Functions
	TaoPhoneComponentAdaptor (TaoTransportTask *&rpSvrTransport, TaoMessage &rMsg, const UtlString &name="TaoPhoneComponentAdaptor", const int maxRequestQMsgs=DEF_MAX_MSGS)
virtual	~TaoPhoneComponentAdaptor ()
virtual UtlBoolean	handleMessage (OsMsg &rMsg)
	Handle an incoming message. More...
TaoStatus	buttonUp (TaoMessage &rMsg)
TaoStatus	buttonDown (TaoMessage &rMsg)
TaoStatus	buttonPress (TaoMessage &rMsg)
TaoStatus	setButtonInfo (TaoMessage &rMsg)
	retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	setHookswState (TaoMessage &rMsg)
	param: (in) buttonInfo - The string to associate with this button retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	setRingerInfo (TaoMessage &rMsg)
TaoStatus	setRingerPattern (TaoMessage &rMsg)
	param: patternIndex - Identifies the pattern whose info string will be modified. param: info - The text string to associate with the specified ringer pattern. retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid pattern index retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	setRingerVolume (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid pattern index retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	setMicGain (TaoMessage &rMsg)
	param: volume - The ringer volume level retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid volume level retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	setSpeakerVolume (TaoMessage &rMsg)
	param: gain - The microphone gain level retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - invalid gain level retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	setExtSpeakerVolume (TaoMessage &rMsg)
	param: volume - The speaker volume level retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid volume level retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	setLampMode (TaoMessage &rMsg)
	param: volume - The speaker volume level retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid volume level retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	setDisplay (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - The requested mode is not supported by this indicator retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	setDisplayContrast (TaoMessage &rMsg)
TaoStatus	activateGroup (TaoMessage &rMsg)
TaoStatus	deactivateGroup (TaoMessage &rMsg)
TaoStatus	returnResult (TaoMessage &rMsg)
TaoStatus	getAssociatedPhoneLamp (TaoMessage &rMsg)
TaoStatus	getHookswState (TaoMessage &rMsg)
	param: (out) rpLamp - The pointer to the associated lamp object retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getHookswCall (TaoMessage &rMsg)
TaoStatus	getButtonInfo (TaoMessage &rMsg)
TaoStatus	getMaxRingPatternIndex (TaoMessage &rMsg)
	param: (out) rpInfo - A pointer to the string associated with this button More...
TaoStatus	getNumberOfRings (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getRingerInfo (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getRingerPattern (TaoMessage &rMsg)
	param: patternIndex - identifies the pattern whose info string will be modified. param: rpInfo - set to point to the text string associated with the specified ringer pattern. retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid pattern index retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getRingerVolume (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getMicGain (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getSpeakerVolume (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getSpeakerNominalVolume (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getExtSpeakerVolume (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getExtSpeakerNominalVolume (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getAssociatedPhoneButton (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getLampMode (TaoMessage &rMsg)
	param: (out) rpButton - The pointer to the associated button object retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getSupportedLampModes (TaoMessage &rMsg)
	retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
TaoStatus	getDisplayRows (TaoMessage &rMsg)
TaoStatus	getDisplayColumns (TaoMessage &rMsg)
TaoStatus	getDisplay (TaoMessage &rMsg)
TaoStatus	getDisplayContrast (TaoMessage &rMsg)
TaoStatus	getGroupComponents (TaoMessage &rMsg)
TaoStatus	getGroupDescription (TaoMessage &rMsg)
TaoStatus	getGroupType (TaoMessage &rMsg)
TaoStatus	isRingerOn (TaoMessage &rMsg)
TaoStatus	isGroupActivated (TaoMessage &rMsg)
	param: (out) rIsOn - TRUE ==> ringer is ON, FALSE ==> ringer is OFF retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available More...
Public Member Functions inherited from TaoAdaptor
	TaoAdaptor (const UtlString &name="TaoAdaptor-%d", const int maxRequestQMsgs=DEF_MAX_MSGS)
	TaoAdaptor (const TaoAdaptor &rTaoAdaptor)
virtual	~TaoAdaptor ()
virtual void	setListenerManager (TaoListenerManager *&rpListenerMgr)
virtual void	parseMessage (TaoMessage &rMsg)
virtual OsStatus	setErrno (int errno)

Protected Attributes
PsButtonTask *	mpButtonTask
PsPhoneTask *	mpPhoneTask
PsHookswTask *	mpHookswTask
TaoTransportTask *	mpSvrTransport
int	mLCDContrast
int	mLCDLow
int	mLCDHigh
int	mLCDOffset
Protected Attributes inherited from TaoAdaptor
unsigned char	mCmd
TaoObjHandle	mMsgID
TaoObjHandle	mObjId
TaoObjHandle	mClientSocket
UtlString	mArgList
int	mArgCnt
TaoListenerManager *	mpListenerMgr

Private Member Functions
	TaoPhoneComponentAdaptor (const TaoPhoneComponentAdaptor &rTaoPhoneComponentAdaptor)
TaoPhoneComponentAdaptor &	operator= (const TaoPhoneComponentAdaptor &rhs)

Private Attributes
TaoPhoneLamp *	mpLamp
UtlString	mInfo
int	mHookswState

Constructor & Destructor Documentation

TaoPhoneComponentAdaptor	(	TaoTransportTask *&	rpSvrTransport,
		TaoMessage &	rMsg,
		const UtlString &	name = "TaoPhoneComponentAdaptor",
		const int	maxRequestQMsgs = DEF_MAX_MSGS
	)

~TaoPhoneComponentAdaptor ( )

virtual

TaoPhoneComponentAdaptor ( const TaoPhoneComponentAdaptor &  rTaoPhoneComponentAdaptor )

private

Member Function Documentation

TaoStatus activateGroup

(

TaoMessage &

rMsg

)

TaoStatus buttonDown

(

TaoMessage &

rMsg

)

TaoStatus buttonPress

(

TaoMessage &

rMsg

)

TaoStatus buttonUp

(

TaoMessage &

rMsg

)

TaoStatus deactivateGroup

(

TaoMessage &

rMsg

)

TaoStatus getAssociatedPhoneButton

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getAssociatedPhoneLamp

(

TaoMessage &

rMsg

)

TaoStatus getButtonInfo

(

TaoMessage &

rMsg

)

TaoStatus getDisplay

(

TaoMessage &

rMsg

)

TaoStatus getDisplayColumns

(

TaoMessage &

rMsg

)

TaoStatus getDisplayContrast

(

TaoMessage &

rMsg

)

TaoStatus getDisplayRows

(

TaoMessage &

rMsg

)

TaoStatus getExtSpeakerNominalVolume

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getExtSpeakerVolume

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getGroupComponents

(

TaoMessage &

rMsg

)

TaoStatus getGroupDescription

(

TaoMessage &

rMsg

)

TaoStatus getGroupType

(

TaoMessage &

rMsg

)

TaoStatus getHookswCall

(

TaoMessage &

rMsg

)

TaoStatus getHookswState

(

TaoMessage &

rMsg

)

param: (out) rpLamp - The pointer to the associated lamp object retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getLampMode

(

TaoMessage &

rMsg

)

param: (out) rpButton - The pointer to the associated button object retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getMaxRingPatternIndex

(

TaoMessage &

rMsg

)

param: (out) rpInfo - A pointer to the string associated with this button

TaoStatus getMicGain

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getNumberOfRings

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getRingerInfo

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getRingerPattern

(

TaoMessage &

rMsg

)

param: patternIndex - identifies the pattern whose info string will be modified. param: rpInfo - set to point to the text string associated with the specified ringer pattern. retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid pattern index retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getRingerVolume

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getSpeakerNominalVolume

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getSpeakerVolume

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus getSupportedLampModes

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

UtlBoolean handleMessage ( OsMsg &  rMsg )

virtual

Handle an incoming message.

If the message is not one that the object is prepared to process, the handleMessage() method in the derived class should return FALSE which will cause the OsServerTask::handleMessage() method to be invoked on the message.

Reimplemented from TaoAdaptor.

TaoStatus isGroupActivated

(

TaoMessage &

rMsg

)

param: (out) rIsOn - TRUE ==> ringer is ON, FALSE ==> ringer is OFF retcode: TAO_SUCCESS - Success retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus isRingerOn

(

TaoMessage &

rMsg

)

TaoPhoneComponentAdaptor & operator= ( const TaoPhoneComponentAdaptor &  rhs )

private

TaoStatus returnResult

(

TaoMessage &

rMsg

)

TaoStatus setButtonInfo

(

TaoMessage &

rMsg

)

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

TaoStatus setDisplay

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - The requested mode is not supported by this indicator retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus setDisplayContrast

(

TaoMessage &

rMsg

)

TaoStatus setExtSpeakerVolume

(

TaoMessage &

rMsg

)

param: volume - The speaker volume level retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid volume level retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus setHookswState

(

TaoMessage &

rMsg

)

param: (in) buttonInfo - The string to associate with this button retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus setLampMode

(

TaoMessage &

rMsg

)

param: volume - The speaker volume level retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid volume level retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus setMicGain

(

TaoMessage &

rMsg

)

param: volume - The ringer volume level retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid volume level retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus setRingerInfo

(

TaoMessage &

rMsg

)

TaoStatus setRingerPattern

(

TaoMessage &

rMsg

)

param: patternIndex - Identifies the pattern whose info string will be modified. param: info - The text string to associate with the specified ringer pattern. retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid pattern index retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus setRingerVolume

(

TaoMessage &

rMsg

)

retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - Invalid pattern index retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

TaoStatus setSpeakerVolume

(

TaoMessage &

rMsg

)

param: gain - The microphone gain level retcode: TAO_SUCCESS - Success retcode: TAO_INVALID_ARGUMENT - invalid gain level retcode: TAO_PROVIDER_UNAVAILABLE - The provider is not available

Member Data Documentation

int mHookswState

private

UtlString mInfo

private

int mLCDContrast

protected

int mLCDHigh

protected

int mLCDLow

protected

int mLCDOffset

protected

PsButtonTask* mpButtonTask

protected

PsHookswTask* mpHookswTask

protected

TaoPhoneLamp* mpLamp

private

PsPhoneTask* mpPhoneTask

protected

TaoTransportTask* mpSvrTransport

protected