sipXcallLib home page


Public Types | Public Member Functions | Protected Attributes | Private Attributes | List of all members
PtPhoneHookswitch Class Reference

#include <PtPhoneHookswitch.h>

Inheritance diagram for PtPhoneHookswitch:
Inheritance graph
[legend]
Collaboration diagram for PtPhoneHookswitch:
Collaboration graph
[legend]

Public Types

enum  HookswitchState { ON_HOOK, OFF_HOOK }
 
- Public Types inherited from PtComponent
enum  ComponentType {
  BUTTON, DISPLAY, GRAPHIC_DISPLAY, HOOKSWITCH,
  LAMP, MICROPHONE, RINGER, SPEAKER,
  TEXT_DISPLAY, EXTERNAL_SPEAKER, UNKNOWN
}
 

Public Member Functions

 PtPhoneHookswitch (PtProvider *&rpProvider)
 enumcode: OFF_HOOK - The phone is off hook enumcode: ON_HOOK - The phone is on hook More...
 
virtual ~PtPhoneHookswitch ()
 
 PtPhoneHookswitch ()
 
 PtPhoneHookswitch (TaoClientTask *pClient)
 
 PtPhoneHookswitch (const PtPhoneHookswitch &rPtPhoneHookswitch)
 
PtPhoneHookswitchoperator= (const PtPhoneHookswitch &rhs)
 
virtual PtStatus setHookswitchState (int state)
 
virtual PtStatus getHookswitchState (int &rState)
 param: state - The state of the hookswitch (either ON_HOOK or OFF_HOOK) retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getCall (PtCall &rCall)
 retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
- Public Member Functions inherited from PtComponent
 PtComponent ()
 
 PtComponent (const PtComponent &rPtComponent)
 
PtComponentoperator= (const PtComponent &rhs)
 
 PtComponent (int componentType)
 
 PtComponent (const char *&rName)
 param: componentType - The type of telephone hardware modeled by this component More...
 
virtual ~PtComponent ()
 param: rName - The name of telephone hardware modeled by this component name: button name: hookswitch name: display name: graphic_display name: text_display name: lamp name: microphone name: ringer name: speaker name: unknown More...
 
void setGroupType (int groupType)
 
virtual PtStatus getName (char *rpName, int maxLen)
 
virtual PtStatus getType (int &rType)
 param: (out) rpName - The reference used to return the name retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 

Protected Attributes

int mState
 
PtProvidermpProvider
 
TaoClientTaskmpClient
 
PtCallmpCall
 
OsTime mTimeOut
 
- Protected Attributes inherited from PtComponent
int mType
 
char mpName [21]
 

Private Attributes

OsProtectEventMgr * mpEventMgr
 

Additional Inherited Members

- Public Attributes inherited from PtComponent
int mGroupType
 

Member Enumeration Documentation

Enumerator
ON_HOOK 
OFF_HOOK 

Constructor & Destructor Documentation

PtPhoneHookswitch ( PtProvider *&  rpProvider)

enumcode: OFF_HOOK - The phone is off hook enumcode: ON_HOOK - The phone is on hook

~PtPhoneHookswitch ( )
virtual
PtPhoneHookswitch ( const PtPhoneHookswitch rPtPhoneHookswitch)

Member Function Documentation

PtStatus getCall ( PtCall rCall)
virtual

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

PtStatus getHookswitchState ( int &  rState)
virtual

param: state - The state of the hookswitch (either ON_HOOK or OFF_HOOK) retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available

PtPhoneHookswitch & operator= ( const PtPhoneHookswitch rhs)
PtStatus setHookswitchState ( int  state)
virtual

Member Data Documentation

PtCall* mpCall
protected
TaoClientTask* mpClient
protected
OsProtectEventMgr* mpEventMgr
private
PtProvider* mpProvider
protected
int mState
protected
OsTime mTimeOut
protected