Abstract base class for all hardware.
Inheritance:
Public Methods
-
ResGwDevice()
-
ResGwDevice( const char* deviceName, Sptr < Fifo < Sptr < SipProxyEvent > > > inputQ, Sptr < Fifo < Sptr < SipProxyEvent > > > outputQ )
- Creates a hardware object to control a single port gateway
-
virtual ~ResGwDevice()
- Destructor
-
virtual void* hardwareMain( void* parms ) = 0
- Starts the main processing loop of the hardware
-
virtual int addToFdSet( fd_set* fd ) = 0
- Add device's socket to the fd; returns 0 if successful, errorcode otherwise
-
virtual int process( fd_set* fd ) = 0
- Process all pending hardware events; returns 0 if successful, otherwise returns an errorcode.
-
virtual int audioStart( const HardwareAudioRequest& request ) = 0
- Start audio channel on device; returns 0 if successful, errorcode otherwise
-
virtual int audioStop() = 0
- Stops audio channel on device; returns 0 if successful, errorcode otherwise
-
virtual int audioSuspend() = 0
- suspend audio channel on device; returns 0 if successful, errorcode otherwise
-
virtual int audioResume( const HardwareAudioRequest& request ) = 0
- resume audio channel on device; returns 0 if successful, errorcode otherwise
-
virtual void processRTP() = 0
-
virtual void setCallId( const Sptr<SipCallId> newCallId )
-
virtual Sptr<SipCallId> getCallId() const
-
virtual void addCallWaitingId( const Sptr<SipCallId> newCallId )
-
virtual Sptr<SipCallId> getCallWaitingId() const
-
virtual void removeCallWaitingId( const SipCallId& newCallId )
-
virtual Sptr<DigitCollector> getDigitCollector()
-
virtual HardwareStatusType getHardwareStatus()
-
virtual bool isMyHardware(const SipCallId& callid)
-
virtual bool isOnCallWaiting(const SipCallId& callid)
-
virtual int getRtpPort() = 0
-
virtual void releaseRtpPort() = 0
-
inline Sptr< Fifo < Sptr<SipProxyEvent> > > getQ()
- access functions to private data
-
inline int getFD()
- returns the file descriptor for the device
-
void setUseRsvp( bool flag )
- RSVP stuff ported from Sessionhxx
Public Members
-
Creates a hardware object to control a multi port gateway
Protected Fields
-
bool useRsvp
- RSVP stuff ported from Sessionhxx
-
int myFD
- file descriptor for hardware device
-
Sptr< Fifo < Sptr< SipProxyEvent > > > myQ
- input queue to allow the session to control hardware signals
-
bool hookStateOffhook
- true if last reported hook state was offhook
-
Sptr<SipCallId> callId
- Current call id
-
Sptr<CallWaitingIdList> callWaitingIdList
- Call Id on call waiting list
-
int stdinFD
- needed for proper terminal control
-
EntryState myEntryState
- this bool is set to true if the user is entering text
-
Data myTextEntry
- this Data contains a partial URL entered by a user if they have entered 'u'
-
Sptr<DigitCollector> digitCollector
Protected Methods
-
virtual void provideDtmf( DeviceSignalType signal ) = 0
-
virtual void provideCallInfo( string CallerId, string CalleeId, string ForwardReason ) = 0
-
int provideSignal( DeviceSignalType signal )
- Trigger the device to send the specified signal; returns 0 if successful, errorcode otherwise
-
void processSessionMsg( Sptr < SipProxyEvent > event )
- Process a msg received from an session
-
void reportEvent( Sptr < Fifo < Sptr< SipProxyEvent > > > outputQ, DeviceEventType eventType )
- Report hardware event by adding it to specified queue
Documentation
Abstract base class for all hardware. Specifies the SIP gateway
hardware API. Defines a basic level of service provided by all
supported hardware interfaces.
ResGwDevice()
ResGwDevice( const char* deviceName, Sptr < Fifo < Sptr < SipProxyEvent > > > inputQ, Sptr < Fifo < Sptr < SipProxyEvent > > > outputQ )
- Creates a hardware object to control a single port gateway
Creates a hardware object to control a multi port gateway
- Creates a hardware object to control a multi port gateway
virtual ~ResGwDevice()
- Destructor
virtual void* hardwareMain( void* parms ) = 0
- Starts the main processing loop of the hardware
virtual int addToFdSet( fd_set* fd ) = 0
- Add device's socket to the fd; returns 0 if successful,
errorcode otherwise
virtual int process( fd_set* fd ) = 0
- Process all pending hardware events; returns 0 if successful,
otherwise returns an errorcode.
virtual int audioStart( const HardwareAudioRequest& request ) = 0
- Start audio channel on device; returns 0 if successful,
errorcode otherwise
virtual int audioStop() = 0
- Stops audio channel on device; returns 0 if successful,
errorcode otherwise
virtual int audioSuspend() = 0
- suspend audio channel on device; returns 0 if successful,
errorcode otherwise
virtual int audioResume( const HardwareAudioRequest& request ) = 0
- resume audio channel on device; returns 0 if successful,
errorcode otherwise
virtual void processRTP() = 0
virtual void setCallId( const Sptr<SipCallId> newCallId )
virtual Sptr<SipCallId> getCallId() const
virtual void addCallWaitingId( const Sptr<SipCallId> newCallId )
virtual Sptr<SipCallId> getCallWaitingId() const
virtual void removeCallWaitingId( const SipCallId& newCallId )
virtual Sptr<DigitCollector> getDigitCollector()
virtual HardwareStatusType getHardwareStatus()
virtual bool isMyHardware(const SipCallId& callid)
virtual bool isOnCallWaiting(const SipCallId& callid)
virtual int getRtpPort() = 0
virtual void releaseRtpPort() = 0
inline Sptr< Fifo < Sptr<SipProxyEvent> > > getQ()
- access functions to private data
inline int getFD()
- returns the file descriptor for the device
void setUseRsvp( bool flag )
- RSVP stuff ported from Sessionhxx
bool useRsvp
- RSVP stuff ported from Sessionhxx
virtual void provideDtmf( DeviceSignalType signal ) = 0
virtual void provideCallInfo( string CallerId, string CalleeId, string ForwardReason ) = 0
int provideSignal( DeviceSignalType signal )
- Trigger the device to send the specified signal; returns 0 if
successful, errorcode otherwise
void processSessionMsg( Sptr < SipProxyEvent > event )
- Process a msg received from an session
void reportEvent( Sptr < Fifo < Sptr< SipProxyEvent > > > outputQ, DeviceEventType eventType )
- Report hardware event by adding it to specified queue
int myFD
- file descriptor for hardware device
Sptr< Fifo < Sptr< SipProxyEvent > > > myQ
- input queue to allow the session to control hardware signals
bool hookStateOffhook
- true if last reported hook state was offhook
Sptr<SipCallId> callId
- Current call id
Sptr<CallWaitingIdList> callWaitingIdList
- Call Id on call waiting list
int stdinFD
- needed for proper terminal control
EntryState myEntryState
- this bool is set to true if the user is entering text
Data myTextEntry
- this Data contains a partial URL entered by a user if they
have entered 'u'
Sptr<DigitCollector> digitCollector
- Direct child classes:
- VmcpDevice
SoundCardDevice
SimpleExtDevice
PhoneCardDevice
DupCardDevice
Alphabetic index HTML hierarchy of classes or Java