MyOpalCall Class Reference

#include <jocall.h>

Collaboration diagram for MyOpalCall:

[legend]List of all members.

Public Member Functions
	MyOpalCall (MyManager &manager, Comms *c)
virtual BOOL	OnSetUp (OpalConnection &connection)
virtual BOOL	OnAlerting (OpalConnection &connection)
virtual BOOL	OnConnected (OpalConnection &connection)
virtual BOOL	OnEstablished (OpalConnection &connection)
virtual void	OnReleased (OpalConnection &connection)
virtual void	OnCleared ()
void	SendThisDtmf (const PString &userInput)
void	AcceptThisCall ()
void	IncomingCall (const PString &remoteNode)
void	CloseThisId ()
PString	GetStatusInfo ()
PString	GetDurationInfo ()
PUDPSocket &	GetAudioSocket ()
Protected Member Functions
void	CheckComms ()
Protected Attributes
MyManager &	manager
Comms &	comms
Comms *	commsPtr
PMutex	commsNotifiedAccess
BOOL	commsNotified

---

Detailed Description

A class the combines the OpalCall structure from OPAL with our protocol handling all messages.

---

Constructor & Destructor Documentation

MyOpalCall::MyOpalCall (  MyManager &  manager, Comms *  c )

Constructor, which adds a message module to the OpalCall class

---

Member Function Documentation

void MyOpalCall::AcceptThisCall (   )

Make the OpalConnections in this call accept this incoming call. This will move the status of the incoming call to connecting.

void MyOpalCall::CheckComms (   )  [protected]

Check that the Comms thing is still running. If it is not running, and we have not noticed it, Clear this call

void MyOpalCall::CloseThisId (   )

Close this id off

PUDPSocket & MyOpalCall::GetAudioSocket (   )

Get a pointer to the PUDPSocket used by this particular call for audio datas

PString MyOpalCall::GetDurationInfo (   )

Get information (in a textual form) of how long this call has been up

PString MyOpalCall::GetStatusInfo (   )

Getinformation for this call on status

void MyOpalCall::IncomingCall (  const PString &  remoteNode  )

Send a request to the remote controller, asking them if we can answer this incoming voip call Parameters: remoteNode  person calling us

BOOL MyOpalCall::OnAlerting (  OpalConnection &  connection  )  [virtual]

Call back for alerting. The default behaviour is to call SetAlerting() on all the other connections in the call. Parameters: connection  Connection that indicates it is alerting

void MyOpalCall::OnCleared (   )  [virtual]

Call back to indicate that the call has been cleared. At this point in time there are no connections left in the call. This causes us to close the communications module for this call.

BOOL MyOpalCall::OnConnected (  OpalConnection &  connection  )  [virtual]

A call back function whenever a connection is "connected". This indicates that a connection to an endpoint was connected. That is the endpoint received acknowledgement via whatever protocol it uses that the connection may now start media streams. Parameters: connection  Connection that indicates it is alerting

BOOL MyOpalCall::OnEstablished (  OpalConnection &  connection  )  [virtual]

This indicates that a connection to an endpoint was connected and that media streams are opened. Parameters: connection  Connection that indicates it is alerting

void MyOpalCall::OnReleased (  OpalConnection &  connection  )  [virtual]

A call back function whenever a connection is released. Parameters: connection  Connection that was established

BOOL MyOpalCall::OnSetUp (  OpalConnection &  connection  )  [virtual]

Call back for SetUp conenction. The default behaviour is to call SetUpConnection() on all the other connections in the call. Parameters: connection  Connection that indicates it is alerting

void MyOpalCall::SendThisDtmf (  const PString &  userInput  )

Send the supplied user input to both connections of this call. The udp sound socket connection will drop it, the voip connection will send it on to the remote endpoint Parameters: value  DTMF to send

---

Member Data Documentation

Comms& MyOpalCall::comms [protected]

The comms class that we use to talk to the remote controller with

BOOL MyOpalCall::commsNotified [protected]

Flag on if the comms is noted to be alive

PMutex MyOpalCall::commsNotifiedAccess [protected]

Mutex to report flag if we have noticied comms is dead

Comms* MyOpalCall::commsPtr [protected]

A pointer to the comms structure, which is somewhat similar to Comms &, but...

MyManager& MyOpalCall::manager [protected]

Link to our controll manager

---

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

• jocall.h
• jocall.cxx

---