# IAX2Connection Class Reference

`#include <iax2con.h>`

Inheritance diagram for IAX2Connection:

[legend]
Collaboration diagram for IAX2Connection:
[legend]

## Public Member Functions

void | StartOperation ()
virtual bool | IsNetworkConnection () const
virtual bool | TransferConnection (const PString &remoteParty)
virtual void | OnReleased ()
OpalMediaFormatList | GetMediaFormats () const
void | EndCallNow (CallEndReason reason=EndedByLocalUser)
void | SendDtmf (const PString &dtmf)
virtual PBoolean | SendUserInputString (const PString &value)
virtual PBoolean | SendUserInputTone (char tone, unsigned duration)
PBoolean | IsCallTerminating ()
virtual void | AnsweringCall (AnswerCallResponse response)
void | OnConnected ()
virtual PBoolean | SetConnected ()
void | OnEstablished ()
PBoolean | SetAlerting (const PString &calleeName, PBoolean withMedia)
virtual OpalMediaStream * | CreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, PBoolean isSource)
void | SetCallToken (PString newToken)
PString | GetCallToken ()
void | TransmitFrameToRemoteEndpoint (IAX2Frame *src)
void | PutSoundPacketToNetwork (PBYTEArray *sund)
void | ReceivedSoundPacketFromNetwork (IAX2Frame *soundFrame)
PBoolean | ReadSoundPacket (RTP_DataFrame &packet)
IAX2Remote & | GetRemoteInfo ()
IAX2SequenceNumbers & | GetSequenceInfo ()
const PTimeInterval & | GetCallStartTick ()
void | OnSetUp ()
PBoolean | SetUpConnection ()
PINDEX | GetSupportedCodecs ()
PINDEX | GetPreferredCodec ()
void | BuildRemoteCapabilityTable (unsigned int remoteCapability, unsigned int format)
unsigned int | ChooseCodec ()
virtual bool | Hold (bool fromRemote, bool placeOnHold)
virtual bool | IsOnHold (bool fromRemote)
void | RemoteHoldConnection ()
void | RemoteRetrieveConnection ()
void | SetUserName (PString &inUserName)
PString | GetUserName () const
void | SetPassword (PString &inPassword)
PString | GetPassword () const
virtual PBoolean | ForwardCall (const PString &forwardParty)
void | IncomingEthernetFrame (IAX2Frame *frame)
IAX2EndPoint & | GetEndPoint ()
void | ReportStatistics ()
Construction/Destruction functions
| IAX2Connection (OpalCall &call, IAX2EndPoint &endpoint, const PString &token, void *userData, const PString &remoteParty, const PString &remotePartyName=PString::Empty())
| ~IAX2Connection ()

## Protected Attributes

PString | userName
PString | password
OpalJitterBuffer | jitterBuffer
RTP_DataFrame::PayloadTypes | opalPayloadType
Internal, protected methods, which are invoked only by this
thread
IAX2EndPoint & | endpoint
OpalMediaFormatList | remoteMediaFormats
OpalMediaFormatList | localMediaFormats
IAX2CallProcessor & | iax2Processor
PBoolean | local_hold
PBoolean | remote_hold

## Friends

class | IAX2CallProcessor

## Detailed Description

This class handles all data associated with a call to one remote computer. It runs a separate thread, which wakes in response to an incoming sound block from a sound device, or inresponse to an incoming ethernet packet, or in response from the UI for action (like sending dtmf)

It is a thread, and runs when activated by outside events.

## Constructor & Destructor Documentation

IAX2Connection::IAX2Connection | ( | OpalCall & | call,
|  | IAX2EndPoint & | endpoint,
|  | const PString & | token,
|  | void * | userData,
|  | const PString & | remoteParty,
|  | const PString & | remotePartyName = `PString::Empty()` |
| ) |  |  |

Construct a connection given the endpoint.

Parameters:

  endpoint | Owner call for connection
  token | Owner iax endpoint for connection
  userData | Token to identify the connection
  remoteParty | Specific user data for this call
  remotePartyName | Url we are calling or getting called byThe name of the remote party

IAX2Connection::~IAX2Connection | ( |  | ) |

Destroy this connection, but do it nicely and let attached sound objects close first.

## Member Function Documentation

virtual void IAX2Connection::AnsweringCall | ( | AnswerCallResponse | response | ) | `[virtual]`

Indicate the result of answering an incoming call. This should only be called if the OnAnswerCall() callback function has returned a AnswerCallPending or AnswerCallDeferred response.

IAX2 traps this call for no "real" reason, except to know for sure when the audio streams start. This can also be regarded as a convenience function, so we know when the call media beings.

Parameters:

  response | response to incoming call

Reimplemented from OpalConnection.

void IAX2Connection::BuildRemoteCapabilityTable | ( | unsigned int | remoteCapability,
|  | unsigned int | format |
| ) |  |  |

Fill the OpalMediaFormatList which describes the remote nodes capabilities

unsigned int IAX2Connection::ChooseCodec | ( |  | ) |

The local capabilites and remote capabilites are in OpalMediaFormatList classes, stored in this class. The local capbilities have already been ordered by the users preferences. The first entry in the remote capabilities is the remote endpoints preferred codec. Now, we have to select a codec to use for this connection. The selected codec is in the binary value defined by FullFrameVoice::AudioSc

virtual OpalMediaStream* IAX2Connection::CreateMediaStream | ( | const OpalMediaFormat & | mediaFormat,
|  | unsigned | sessionID,
|  | PBoolean | isSource |
| ) |  |  | `[virtual]`

Open a new media stream. This will create a media stream of class OpalIAX2MediaStream.

Note that media streams may be created internally to the underlying protocol. This function is not the only way a stream can come into existance.

Parameters:

  mediaFormat | Media format for stream
  sessionID | Session number for stream
  isSource | Is a source stream

Reimplemented from OpalConnection.

void IAX2Connection::EndCallNow | ( | CallEndReason | reason = `EndedByLocalUser` | ) |

Cause the call to end now, but do not send any iax hangup frames etc

Parameters:

  reason | Reason for call clearing

virtual PBoolean IAX2Connection::ForwardCall | ( | const PString & | forwardParty | ) | `[virtual]`

Forward incoming call to specified address. This would typically be called from within the OnIncomingCall() function when an application wishes to redirct an unwanted incoming call.

The return value is true if the call is to be forwarded, false otherwise. Note that if the call is forwarded the current connection is cleared with teh ended call code of EndedByCallForwarded.

Parameters:

  forwardParty | Party to forward call to.

Reimplemented from OpalConnection.

const PTimeInterval& IAX2Connection::GetCallStartTick | ( |  | ) | `[inline]`

Get the call start time

PString IAX2Connection::GetCallToken | ( |  | ) | `[inline]`

Return the string that identifies this IAX2Connection instance

IAX2EndPoint& IAX2Connection::GetEndPoint | ( |  | ) | `[inline]`

Return reference to the endpoint class

OpalMediaFormatList IAX2Connection::GetMediaFormats | ( |  | ) | const`[inline, virtual]`

Get the data formats this connection is capable of operating. This provides a list of media data format names that a OpalMediaStream may be created in within this connection.

This method returns media formats that were decided through the initial exchange of packets when setting up a call (the cmdAccept and cmdNew packets).

The OpalConnection has this method as pure, so it is defined for IAX2.

Reimplemented from OpalConnection.

PString IAX2Connection::GetPassword | ( |  | ) | const`[inline]`

Get the password

PINDEX IAX2Connection::GetPreferredCodec | ( |  | ) |

Return the bitmask which specifies the preferred codec. The selected codec is in the binary value defined by FullFrameVoice::AudioSc

IAX2Remote& IAX2Connection::GetRemoteInfo | ( |  | ) | `[inline]`

Get information on Remote class (remote node address & port + source & dest call number.)

IAX2SequenceNumbers& IAX2Connection::GetSequenceInfo | ( |  | ) | `[inline]`

Get the sequence number info (inSeqNo and outSeqNo)

PINDEX IAX2Connection::GetSupportedCodecs | ( |  | ) |

Return the bitmask which specifies the possible codecs we support. The supported codecs are a bitmask of values defined by FullFrameVoice::AudioSc

PString IAX2Connection::GetUserName | ( |  | ) | const`[inline]`

Get the username

virtual bool IAX2Connection::Hold | ( | bool | fromRemote,
|  | bool | placeOnHold |
| ) |  |  | `[virtual]`

Put the current connection on hold, suspending all media streams. The `fromRemote` parameter indicates if we a putting the remote on hold (false) or it is a request for the remote to put us on hold (true).

The /p placeOnHold parameter indicates of teh command/request is for going on hold or retrieving from hold.

Parameters:

  fromRemote | Flag for if remote has us on hold, or we have them
  placeOnHold | Flag for setting on or off hold

Reimplemented from OpalConnection.

void IAX2Connection::IncomingEthernetFrame | ( | IAX2Frame * | frame | ) |

Handle a received IAX frame. This may be a mini frame or full frame. Typically, this connection instance will immediately pass the frame on to the CallProcessor::IncomingEthernetFrame() method.

PBoolean IAX2Connection::IsCallTerminating | ( |  | ) | `[inline]`

Report if this Connection is still active

virtual bool IAX2Connection::IsNetworkConnection | ( |  | ) | const`[inline, virtual]`

Get indication of connection being to a "network". This indicates the if the connection may be regarded as a "network" connection. The distinction is about if there is a concept of a "remote" party being connected to and is best described by example: sip, h323, iax and pstn are all "network" connections as they connect to something "remote". While pc, pots and ivr are not as the entity being connected to is intrinsically local.

Implements OpalConnection.

virtual bool IAX2Connection::IsOnHold | ( | bool | fromRemote | ) | `[virtual]`

Return true if the current connection is on hold. The `fromRemote` parameter indicates if we are testing if the remote system has us on hold, or we have them on hold.

Parameters:

  fromRemote | Flag for if remote has us on hold, or we have them

Reimplemented from OpalConnection.

void IAX2Connection::OnConnected | ( |  | ) | `[virtual]`

Capture an Opal generated call back, which tells us the media streams are about to start. In this method, we start the jitter buffer for the IAX2 audio packets, and then call the OPAL OnConnected method to ensure the proper handling takes place.

That this method is called is an indication that the remote endpoint has answered our call and is happy for the call to proceed.

Reimplemented from OpalConnection.

void IAX2Connection::OnEstablished | ( |  | ) | `[virtual]`

A call back function whenever a connection is established. This indicates that a connection to an endpoint was established. This usually occurs after OnConnected() and indicates that the connection is both connected and has media flowing.

In the context of IAX2 this means we have received the first full frame of media from the remote endpoint

This method runs when a media stream in OpalConnection is opened. This callback is used to indicate we need to start the "every 10 second do an iax2 lagrq/lagrp+ping/pong exhange process".

This exchange proces is invoked in the IAX2CallProcessor.

Reimplemented from OpalConnection.

virtual void IAX2Connection::OnReleased | ( |  | ) | `[virtual]`

Clean up the termination of the connection. This function can do any internal cleaning up and waiting on background threads that may be using the connection object.

Note that there is not a one to one relationship with the OnEstablishedConnection() function. This function may be called without that function being called. For example if SetUpConnection() was used but the call never completed.

Classes that override this function should make sure they call the ancestor version for correct operation.

An application will not typically call this function as it is used by the OpalManager during a release of the connection.

The default behaviour calls the OpalEndPoint function of the same name.

Reimplemented from OpalConnection.

void IAX2Connection::OnSetUp | ( |  | ) |

We have received a packet from the remote iax endpoint, requeting a call. Now, we use this method to invoke the opal components to do their bit.

This method is called after OnIncomingConnection().

void IAX2Connection::PutSoundPacketToNetwork | ( | PBYTEArray * | sund | ) |

Handle a sound packet received from the sound device.

Now onsend this to the remote endpoint.

PBoolean IAX2Connection::ReadSoundPacket | ( | RTP_DataFrame & | packet | ) |

Grab a sound packet from the jitterBuffer in this class. Return it to the requesting process, which is in an instance of the OpalIAX2MediaStream class. Note that this class returns RTP_DataFrame instances. These RTP_DataFrame instances were generated by the IAX2CallProcessor class.

void IAX2Connection::ReceivedSoundPacketFromNetwork | ( | IAX2Frame * | soundFrame | ) |

We have received an iax2 sound frame from the network. This method places it in the jitter buffer (a member of this class)

void IAX2Connection::RemoteHoldConnection | ( |  | ) |

Signal that the remote side has put the connection on hold

void IAX2Connection::RemoteRetrieveConnection | ( |  | ) |

Signal that the remote side has retrieved the connection

void IAX2Connection::ReportStatistics | ( |  | ) |

Invoked by the User interface, which causes the statistics (count of in/out packets) to be printed

void IAX2Connection::SendDtmf | ( | const PString & | dtmf | ) |

Provided as a link between the iax endpoint and the iax processor

virtual PBoolean IAX2Connection::SendUserInputString | ( | const PString & | value | ) | `[virtual]`

sending text fullframes

Reimplemented from OpalConnection.

virtual PBoolean IAX2Connection::SendUserInputTone | ( | char | tone,
|  | unsigned | duration |
| ) |  |  | `[virtual]`

sending dtmf - which is 1 char per IAX2FullFrameDtmf on the frame.

Reimplemented from OpalConnection.

PBoolean IAX2Connection::SetAlerting | ( | const PString & | calleeName,
|  | PBoolean | withMedia |
| ) |  |  | `[virtual]`

Indicate to remote endpoint an alert is in progress. If this is an incoming connection and the AnswerCallResponse is in a AnswerCallDeferred or AnswerCallPending state, then this function is used to indicate to that endpoint that an alert is in progress. This is usually due to another connection which is in the call (the B party) has received an OnAlerting() indicating that its remoteendpoint is "ringing".

The OpalConnection has this method as pure, so it is defined for IAX2.

Parameters:

  calleeName | Name of endpoint being alerted.
  withMedia | Open media with alerting

Reimplemented from OpalConnection.

void IAX2Connection::SetCallToken | ( | PString | newToken | ) |

Give the call token a value. The call token is the ipaddress of the remote node concatented with the remote nodes src number. This is guaranteed to be unique. Sadly, if this connection is setting up the call, the callToken is not known until receipt of the first packet from the remote node.

However, if this connection is created in response to a call, this connection can determine the callToken on examination of that incoming first packet

virtual PBoolean IAX2Connection::SetConnected | ( |  | ) | `[virtual]`

Indicate to remote endpoint we are connected. In other words, tell the remote endpoint we accept the call and things proceed with the call eventuallly moving to established phase.

In addition to the OpalConnection::SetConnected method, we have to do the iax2 connection stuff, which is to send an iax2 answer packet to the remote host.

The IAX2 answer packet is sent by the iax2 call processor, and indicates we have agreed to the incoming call.

Reimplemented from OpalConnection.

void IAX2Connection::SetPassword | ( | PString & | inPassword | ) | `[inline]`

Set the password for when we connect to a remote node we use it as authentication. Note this must only be used before SetUpConnection is ran. This is optional because some servers do not required authentication, also if it is not set then the default iax2Ep password will be used instead.

PBoolean IAX2Connection::SetUpConnection | ( |  | ) | `[virtual]`

Start an outgoing connection. This function will initiate the connection to the remote entity, for example in H.323 it sends a SETUP, in SIP it sends an INVITE etc. In IAX2, it sends a New packet..

The behaviour at the opal level is pure. Here, the method is defined.

Reimplemented from OpalConnection.

void IAX2Connection::SetUserName | ( | PString & | inUserName | ) | `[inline]`

Set the username for when we connect to a remote node we use it as authentication. Note this must only be used before SetUpConnection is ran. This is optional because some servers do not required authentication, also if it is not set then the default iax2Ep username will be used instead.

void IAX2Connection::StartOperation | ( |  | ) |

this method starts the callprocessor of a connection, and maves the phase to setup. Essentially, we start the entire call handling process here.

virtual bool IAX2Connection::TransferConnection | ( | const PString & | remoteParty | ) | `[virtual]`

Initiate the transfer of an existing call (connection) to a new remote party.

If remoteParty is a valid call token, then the remote party is transferred to that party (consultation transfer) and both calls are cleared.

Parameters:

  remoteParty | Remote party to transfer the existing call to

Reimplemented from OpalConnection.

void IAX2Connection::TransmitFrameToRemoteEndpoint | ( | IAX2Frame * | src | ) |

Transmit IAX2Frame to remote endpoint, It is only called by the the IAXProcessor class.

## Friends And Related Function Documentation

friend class IAX2CallProcessor `[friend]`

## Field Documentation

IAX2EndPoint& IAX2Connection::endpoint `[protected]`

Global variable which specifies IAX2 protocol specific issues

Reimplemented from OpalConnection.

IAX2CallProcessor& IAX2Connection::iax2Processor `[protected]`

The thread that processes the list of pending frames on this class

OpalJitterBuffer IAX2Connection::jitterBuffer `[protected]`

This jitter buffer smooths out the delivery times from the network, so that packets arrive in schedule at the far end.

PBoolean IAX2Connection::local_hold `[protected]`

Whether the connection is on hold locally

OpalMediaFormatList IAX2Connection::localMediaFormats `[protected]`

The list of media formats (codecs) this end wants to use. This list is defined on constructing this IAX2Connection class

RTP_DataFrame::PayloadTypes IAX2Connection::opalPayloadType `[protected]`

The payload type, which we put on all RTP_DataFrame packets. This variable is placed on all RTP_DataFrame instances, prior to placing these frames into the jitter buffer.

This variable is not used in the transmission of frames.

Note that this variable describes the payload type as opal sees it.

PString IAX2Connection::password `[protected]`

Password for the iax2CallProcessor

PBoolean IAX2Connection::remote_hold `[protected]`

Whether the connection is on hold remotely

OpalMediaFormatList IAX2Connection::remoteMediaFormats `[protected]`

The list of media formats (codecs) the remote enpoint can use. This list is defined on receiving a particular Inforation Element

PString IAX2Connection::userName `[protected]`

Username for the iax2CallProcessor

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

- iax2con.h