OPAL  Version 3.10.10
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
IAX2RegProcessor Class Reference

#include <regprocessor.h>

Inheritance diagram for IAX2RegProcessor:
IAX2Processor

Public Member Functions

 IAX2RegProcessor (IAX2EndPoint &ep, const PString &host, const PString &username, const PString &password, PINDEX inRegistrationRefreshTime)
 
virtual ~IAX2RegProcessor ()
 
void Unregister ()
 
PString GetHost () const
 
PString GetUserName () const
 
PString GetPassword () const
 
- Public Member Functions inherited from IAX2Processor
 IAX2Processor (IAX2EndPoint &ep)
 
virtual ~IAX2Processor ()
 
IAX2SequenceNumbers & GetSequenceInfo ()
 
IAX2Encryption & GetEncryptionInfo ()
 
void IncomingEthernetFrame (IAX2Frame *frame)
 
IAX2EndPoint & GetEndPoint ()
 
void SetCallToken (const PString &newToken)
 
PString GetCallToken ()
 
IAX2Remote & GetRemoteInfo ()
 
const PTimeInterval & GetCallStartTick ()
 
void Main ()
 
PBoolean IsStatusQueryEthernetFrame (IAX2Frame *frame)
 
void SetSpecialPackets (PBoolean newValue)
 
void Terminate ()
 
void Activate ()
 
void ReportLists (PString &answer)
 

Protected Types

enum  RegistrationState {
  registrationStart = 1, registrationHappening, registrationUnregisterStart, registrationUnregistering,
  registrationUnregistered, registrationWait
}
 
- Protected Types inherited from IAX2Processor
enum  DefinedNoResponseTimePeriod { NoResponseTimePeriod = 5000 }
 

Protected Member Functions

void OnDoRegistration (PTimer &, INT)
 
void ProcessIaxCmdRegAuth (IAX2FullFrameProtocol *src)
 
void ProcessIaxCmdRegAck (IAX2FullFrameProtocol *src)
 
void ProcessIaxCmdRegRej (IAX2FullFrameProtocol *src)
 
void ProcessIaxCmdUnRegAuth (IAX2FullFrameProtocol *src)
 
void ProcessIaxCmdUnRegAck (IAX2FullFrameProtocol *src)
 
void ProcessIaxCmdUnRegRej (IAX2FullFrameProtocol *src)
 
void OnNoResponseTimeout ()
 
void PrintOn (ostream &strm) const
 
virtual void ProcessLists ()
 
virtual void ProcessFullFrame (IAX2FullFrame &fullFrame)
 
virtual void ProcessNetworkFrame (IAX2MiniFrame *src)
 
virtual PBoolean ProcessNetworkFrame (IAX2FullFrameProtocol *src)
 
void ResetCall ()
 
virtual PBoolean IncomingMessageOutOfOrder (IAX2FullFrame *)
 
- Protected Member Functions inherited from IAX2Processor
void StartNoResponseTimer (PINDEX msToWait=60000)
 
void StopNoResponseTimer ()
 
void CleanPendingLists ()
 
PBoolean IsHandlingSpecialPackets ()
 
virtual void ProcessIaxCmdLagRq (IAX2FullFrameProtocol *src)
 
virtual void ProcessIaxCmdLagRp (IAX2FullFrameProtocol *src)
 
virtual void ProcessIaxCmdVnak (IAX2FullFrameProtocol *src)
 
virtual void ProcessIaxCmdPing (IAX2FullFrameProtocol *src)
 
virtual void ProcessIaxCmdPong (IAX2FullFrameProtocol *src)
 
PBoolean ProcessOneIncomingEthernetFrame ()
 
void IncControlFramesSent ()
 
void IncControlFramesRcvd ()
 
void TransmitFrameToRemoteEndpoint (IAX2Frame *src)
 
void TransmitFrameToRemoteEndpoint (IAX2FullFrame *src, IAX2WaitingForAck::ResponseToAck response)
 
void TransmitFrameNow (IAX2Frame *src)
 
void TransmitFrameToRemoteEndpoint (IAX2FullFrameProtocol *src)
 
PBoolean Authenticate (IAX2FullFrameProtocol *reply, PString &password)
 
void SendAckFrame (IAX2FullFrame *inReplyTo)
 
void SendVnakFrame (IAX2FullFrame *inReplyTo)
 
void SendUnsupportedFrame (IAX2FullFrame *inReplyTo)
 

Protected Attributes

PString host
 
PString userName
 
PString password
 
INT registrationRefreshTime
 
RegistrationState registrationState
 
PMutex stateMutex
 
PTimer registrationTimer
 
PRandom regRandom
 
- Protected Attributes inherited from IAX2Processor
IAX2EndPoint & endpoint
 
PTimeInterval callStartTick
 
IAX2Remote remote
 
PTimer noResponseTimer
 
IAX2WaitingForAck nextTask
 
PSyncPoint activate
 
PBoolean endThread
 
IAX2Encryption encryption
 
IAX2SequenceNumbers sequence
 
IAX2ActiveFrameList frameList
 
SafeString callToken
 
PBoolean specialPackets
 
PAtomicInteger controlFramesSent
 
PAtomicInteger controlFramesRcvd
 
IAX2IeData ieData
 
DWORD currentSoundTimeStamp
 

Member Enumeration Documentation

◆ RegistrationState

enum IAX2RegProcessor::RegistrationState
protected

bit mask of the different flags to indicate call status

Enumerator
registrationStart 

Intial state of registration

registrationHappening 

The registration process is happening

registrationUnregisterStart 

The unregistration process is about to begin

registrationUnregistering 

The unregistration process is happening

registrationUnregistered 

The unregistration process is complete and is waiting for termination

registrationWait 

Waiting for the refresh peroid

Constructor & Destructor Documentation

◆ IAX2RegProcessor()

IAX2RegProcessor::IAX2RegProcessor ( IAX2EndPoint &  ep,
const PString &  host,
const PString &  username,
const PString &  password,
PINDEX  inRegistrationRefreshTime 
)

Construct this class

◆ ~IAX2RegProcessor()

virtual IAX2RegProcessor::~IAX2RegProcessor ( )
virtual

Destructor

Member Function Documentation

◆ GetHost()

PString IAX2RegProcessor::GetHost ( ) const
inline

References host.

◆ GetPassword()

PString IAX2RegProcessor::GetPassword ( ) const
inline

◆ GetUserName()

PString IAX2RegProcessor::GetUserName ( ) const
inline

References userName.

◆ IncomingMessageOutOfOrder()

virtual PBoolean IAX2RegProcessor::IncomingMessageOutOfOrder ( IAX2FullFrame *  )
inlineprotectedvirtual

Test the sequence number of the incoming frame. This is only valid for handling a call. If the message is outof order, the supplied fullframe is deleted.

Returns
true if the frame is out of order, which deletes the supplied frame
false, and does not destroy the supplied frame

Implements IAX2Processor.

◆ OnDoRegistration()

void IAX2RegProcessor::OnDoRegistration ( PTimer &  ,
INT   
)
protected

A pwlib callback function to start the registration process again

◆ OnNoResponseTimeout()

void IAX2RegProcessor::OnNoResponseTimeout ( )
protectedvirtual

This callback is called when a packet fails to get an Acknowledgment

Implements IAX2Processor.

◆ PrintOn()

void IAX2RegProcessor::PrintOn ( ostream &  strm) const
protectedvirtual

A method to cause some of the values in this class to be formatted into a printable stream

Implements IAX2Processor.

◆ ProcessFullFrame()

virtual void IAX2RegProcessor::ProcessFullFrame ( IAX2FullFrame &  fullFrame)
protectedvirtual

Processes a full frame, and sends it off to the relevant processor. This RegistrationProcessor instance worries about those types common to registration, so is concerned about cmdRegAuth, cmdRegAck etc.

Implements IAX2Processor.

◆ ProcessIaxCmdRegAck()

void IAX2RegProcessor::ProcessIaxCmdRegAck ( IAX2FullFrameProtocol *  src)
protected

Process an acknowledgement of a sucessful registration

◆ ProcessIaxCmdRegAuth()

void IAX2RegProcessor::ProcessIaxCmdRegAuth ( IAX2FullFrameProtocol *  src)
protected

Process an authentication request when registering

◆ ProcessIaxCmdRegRej()

void IAX2RegProcessor::ProcessIaxCmdRegRej ( IAX2FullFrameProtocol *  src)
protected

Process a registration rejection

◆ ProcessIaxCmdUnRegAck()

void IAX2RegProcessor::ProcessIaxCmdUnRegAck ( IAX2FullFrameProtocol *  src)
protected

Process an acknowledgement of a registration release

◆ ProcessIaxCmdUnRegAuth()

void IAX2RegProcessor::ProcessIaxCmdUnRegAuth ( IAX2FullFrameProtocol *  src)
protected

Process an authentication request when registering doing a registration release

◆ ProcessIaxCmdUnRegRej()

void IAX2RegProcessor::ProcessIaxCmdUnRegRej ( IAX2FullFrameProtocol *  src)
protected

Process a registration release rejection

◆ ProcessLists()

virtual void IAX2RegProcessor::ProcessLists ( )
protectedvirtual

Go through the three lists for incoming data (ethernet/sound/UI commands.

Implements IAX2Processor.

◆ ProcessNetworkFrame() [1/2]

virtual void IAX2RegProcessor::ProcessNetworkFrame ( IAX2MiniFrame *  src)
protectedvirtual

Handles a mini frame - so copes with media.

Implements IAX2Processor.

◆ ProcessNetworkFrame() [2/2]

virtual PBoolean IAX2RegProcessor::ProcessNetworkFrame ( IAX2FullFrameProtocol *  src)
protectedvirtual

Processes a protocol full frame, well, those components relating to registration.

Reimplemented from IAX2Processor.

◆ ResetCall()

void IAX2RegProcessor::ResetCall ( )
protected

Reset the call, ie: get a new call source number, put the sequence numbers to 0 and reset the timer. This solves having to create a new thread for every seperate call.

◆ Unregister()

void IAX2RegProcessor::Unregister ( )

Unregister from the remote iax2 server. This method is synchronous. and could take until the Timeout peroid to return. This will also shutdown the main thread.

Field Documentation

◆ host

PString IAX2RegProcessor::host
protected

Referenced by GetHost().

◆ password

PString IAX2RegProcessor::password
protected

◆ registrationRefreshTime

INT IAX2RegProcessor::registrationRefreshTime
protected

◆ registrationState

RegistrationState IAX2RegProcessor::registrationState
protected

The current state of the registration

◆ registrationTimer

PTimer IAX2RegProcessor::registrationTimer
protected

The timer which is used to send a registration message

◆ regRandom

PRandom IAX2RegProcessor::regRandom
protected

A class that generates random values used for varying the registration timer

◆ stateMutex

PMutex IAX2RegProcessor::stateMutex
protected

A mutex to protect the registrationState variable and the flow of the RegProcessor.

◆ userName

PString IAX2RegProcessor::userName
protected

Referenced by GetUserName().

The documentation for this class was generated from the following file: