sipXcallLib home page


Public Member Functions | List of all members
PtPhoneTerminal Class Reference

#include <PtPhoneTerminal.h>

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

Public Member Functions

 PtPhoneTerminal ()
 
virtual ~PtPhoneTerminal ()
 
 PtPhoneTerminal (const PtPhoneTerminal &rPtPhoneTerminal)
 
 PtPhoneTerminal (const char *terminalName)
 
PtPhoneTerminaloperator= (const PtPhoneTerminal &rhs)
 
virtual PtStatus getComponentGroups (PtComponentGroup *pComponentGroup[], int size, int &nItems)
 
- Public Member Functions inherited from PtTerminal
 PtTerminal ()
 
 PtTerminal (const char *terminalName, TaoClientTask *pClient=NULL)
 
virtual ~PtTerminal ()
 
 PtTerminal (const PtTerminal &rPtTerminal)
 
PtTerminaloperator= (const PtTerminal &rhs)
 
virtual PtStatus addCallListener (PtCallListener &rCallListener)
 
virtual PtStatus addTerminalListener (PtTerminalListener &rTerminalListener)
 param: (in) rCallListener - the listener to add to calls associated with this terminal retcode: PT_SUCCESS - Success retcode: PT_EXISTS - rCallListener is already registered retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
PtStatus setGatewayInterface (PtGatewayInterface &rGatewayInterface)
 param: (in) rTerminalListener - The listener to add to this terminal retcode: PT_SUCCESS - Success retcode: PT_EXISTS - rTerminalListener is already registered retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus pickup (PtAddress &rPickupAddress, PtAddress &rTerminalAddress, PtTerminalConnection *&rpNewTermConnection)
 param: (in) rGatewayInterface - reference to the gateway interface on which media setup methods are invoked during in/out going call setup for this terminal. retcode: PT_SUCCESS - Success retcode: PT_EXISTS - rGatewayInterface is already registered on this terminal. retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus removeCallListener (PtCallListener &rCallListener)
 param: rPickupAddress - The PtAddress that is to be picked up param: rTerminalAddress - The PtAddress associated with this terminal on which to pick up the call param: rpNewTermConnection - Set to point to the PtTerminalConnection corresponding to the picked up PtConnection. retcode: PT_SUCCESS - Success retcode: PT_INVALID_STATE - There is no connection for rTerminalAddress in either the QUEUED or ALERTING state. retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus removeTerminalListener (PtTerminalListener &rTerminalListener)
 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) rTerminalListener - The listener to remove from this terminal retcode: PT_SUCCESS - Success retcode: PT_NOT_FOUND - rTerminalListener not registered retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus setCodecCPULimit (int limit)
 param: (in) flag - TRUE ==> enable, FALSE ==> disable retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getAddresses (PtAddress addresses[], int size, int &nItems)
 param (in) limit - The codec/CPU limit for this call. The value can More...
 
virtual PtStatus getCallListeners (PtCallListener aCallListeners[], int size, int &nItems)
 param: (out) aAddresses - The array of PtAddress's param: (in) size - The number of elements in the addresses array param: (out) nItems - The number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - There are more than size addresses retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getComponent (const char *componentName, PtComponent &rComponent)
 param: (out) aCallListeners - The array of 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 getComponents (PtComponent *components[], int size, int &nItems)
 param: (in) componentName - The name of the desired component param: (out) rpComponent - Set to point to the component that corresponds to componentName retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getComponentGroups (PtComponentGroup componentGroup[], int size, int &nItems)
 param: (out) components - The array of PtComponent's param: (in) size - The number of elements in the components array param: (out) nItems - The number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - There are more than size components retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getConfiguration (PtConfigDb &rpConfigDb)
 param: (out) pComponentGroup - The array of PtComponetGroups param: (in) size - The number of elements in the components array param: (out) nItems - The number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - There are more than size components retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getDoNotDisturb (PtBoolean &rFlag)
 retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
PtStatus getName (char *rpName, int maxLen)
 param: (out) rFlag - TRUE ==> enabled, FALSE ==> disabled retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus getTerminalListeners (PtTerminalListener aTermListeners[], int size, int &nItems)
 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) aTermListeners - The array of known terminal listeners param: (in) size - The number of elements in the termListeners 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 getTerminalConnections (PtTerminalConnection termConnections[], int size, int &nItems)
 param: (out) rpProvider - a reference to the PtProvider object associated with this terminal retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus numAddresses (int &count)
 param: (out) aTermConnections - The array of PtTerminalConnection objects param: (in) size - The number of elements in the termConnections array param: (out) nItems - The number of items assigned retcode: PT_SUCCESS - Success retcode: PT_MORE_DATA - There are more than size terminal connections retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus numCallListeners (int &count)
 param: (out) count - The number of addresses associated with this terminal retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus numComponents (int &count)
 param: (out) count - The number of call listeners associated with this terminal retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus numTerminalConnections (int &count)
 param: (out) count - The number of components associated with this terminal retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 
virtual PtStatus numTerminalListeners (int &count)
 param: (out) count - The number of terminal connections associated with this terminal retcode: PT_SUCCESS - Success retcode: PT_PROVIDER_UNAVAILABLE - The provider is not available More...
 

Additional Inherited Members

- Protected Types inherited from PtTerminal
enum  PtComponentId {
  HEAD_SET = 1, HAND_SET, PHONE_SET, SPEAKER_PHONE,
  OTHER, BUTTON, DISPLAY, GRAPHIC_DISPLAY,
  HOOKSWITCH, LAMP, MICROPHONE, RINGER,
  SPEAKER, EXTERNAL_SPEAKER
}
 
- Protected Member Functions inherited from PtTerminal
void initialize (const char *name)
 
- Protected Attributes inherited from PtTerminal
OsTime mTimeOut
 
char mTerminalName [PTTERMINAL_MAX_NAME_LENGTH+1]
 
TaoClientTaskmpClient
 
- Static Protected Attributes inherited from PtTerminal
static OsBSem semInit
 
static TaoReferencempTransactionCnt = 0
 
static TaoObjectMapmpComponents = 0
 
static TaoObjectMapmpComponentGroups = 0
 
static int mRef = 0
 

Constructor & Destructor Documentation

~PtPhoneTerminal ( )
virtual
PtPhoneTerminal ( const PtPhoneTerminal rPtPhoneTerminal)
PtPhoneTerminal ( const char *  terminalName)

Member Function Documentation

PtStatus getComponentGroups ( PtComponentGroup pComponentGroup[],
int  size,
int &  nItems 
)
virtual
PtPhoneTerminal & operator= ( const PtPhoneTerminal rhs)