OpalUdpSsConnection Class Reference

#include <udpconnection.h>

Collaboration diagram for OpalUdpSsConnection:

[legend]List of all members.

Public Member Functions
Construction
	OpalUdpSsConnection (OpalCall &call, OpalUdpSsEndPoint &endpoint, const PString &newToken)
	~OpalUdpSsConnection ()
Overrides from OpalConnection
virtual BOOL	SetUpConnection ()
virtual BOOL	SetAlerting (const PString &calleeName, BOOL withMedia)
virtual void	OnEstablished ()
virtual BOOL	SetConnected ()
virtual PString	GetDestinationAddress ()
virtual OpalMediaFormatList	GetMediaFormats () const
virtual OpalMediaStream *	CreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, BOOL isSource)
virtual BOOL	OnOpenMediaStream (OpalMediaStream &stream)
virtual BOOL	SendUserInputString (const PString &value)
New operations
virtual void	InitiateCall ()
virtual void	AcceptIncoming ()
virtual PSoundChannel *	CreateSoundChannel (BOOL isSource)
Protected Attributes
OpalUdpSsEndPoint &	endpoint

---

Detailed Description

UDP Sound System connection.

---

Constructor & Destructor Documentation

OpalUdpSsConnection::OpalUdpSsConnection (  OpalCall &  call, OpalUdpSsEndPoint &  endpoint, const PString &  newToken )

Create a new endpoint. Parameters: call  Owner calll for connection ep  Owner endpoint for connection newToken  token for this connection

OpalUdpSsConnection::~OpalUdpSsConnection (   )

Destroy endpoint.

---

Member Function Documentation

void OpalUdpSsConnection::AcceptIncoming (   )  [virtual]

Accept the incoming connection.

OpalMediaStream * OpalUdpSsConnection::CreateMediaStream (  const OpalMediaFormat &  mediaFormat, unsigned  sessionID, BOOL  isSource )  [virtual]

Open a new media stream. This will create a media stream of an appropriate subclass as required by the underlying connection protocol. For instance H.323 would create an OpalRTPStream. The sessionID parameter may not be needed by a particular media stream and may be ignored. In the case of an OpalRTPStream it us used. 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. The default behaviour is pure. Parameters: sessionID  Media format for stream isSource  Session number for stream Is a source stream

PSoundChannel * OpalUdpSsConnection::CreateSoundChannel (  BOOL  isSource  )  [virtual]

Create an PSoundChannel based media stream.

PString OpalUdpSsConnection::GetDestinationAddress (   )  [virtual]

Get the destination address of an incoming connection. The default behaviour collects a DTMF number terminated with a '#' or if no digits were entered for a time (default 3 seconds). If no digits are entered within a longer time time (default 30 seconds), then an empty string is returned.

OpalMediaFormatList OpalUdpSsConnection::GetMediaFormats (   )  const [virtual]

Get the data formats this connection is capable of operating. This provides a list of media data format names that an OpalMediaStream may be created in within this connection. The default behaviour returns the formats the PSoundChannel can do, typically only PCM-16.

void OpalUdpSsConnection::InitiateCall (   )  [virtual]

Call is initiated as the A-Party.

void OpalUdpSsConnection::OnEstablished (   )  [virtual]

Called at the end of the call setup process. Audio is happening now

BOOL OpalUdpSsConnection::OnOpenMediaStream (  OpalMediaStream &  stream  )  [virtual]

Call back when opening a media stream. This function is called when a connection has created a new media stream according to the logic of its underlying protocol. The usual requirement is that media streams are created on all other connections participating in the call and all of the media streams are attached to an instance of an OpalMediaPatch object that will read from one of the media streams passing data to the other media streams. The default behaviour calls the ancestor and adds a PCM silence detector filter. Parameters: mediaStream  New media stream being opened

BOOL OpalUdpSsConnection::SendUserInputString (  const PString &  value  )  [virtual]

Send a user input indication to the remote endpoint. Since this connection goes to the udp audio socket, we take all user input strings and drop them. Parameters: value  String value of indication

BOOL OpalUdpSsConnection::SetAlerting (  const PString &  calleeName, BOOL  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 remote endpoint is "ringing". The default behaviour does nothing. Parameters: withMedia  Name of endpoint being alerted. Open media with alerting

BOOL OpalUdpSsConnection::SetConnected (   )  [virtual]

Indicate to remote endpoint we are connected. The default behaviour does nothing.

BOOL OpalUdpSsConnection::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. The default behaviour does.

---

Member Data Documentation

OpalUdpSsEndPoint& OpalUdpSsConnection::endpoint [protected]

The end point that describes us

---

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

• udpconnection.h
• udpconnection.cxx

---