OpalUdpSsEndPoint Class Reference

#include <udpep.h>

Inheritance diagram for OpalUdpSsEndPoint:

[legend]List of all members.

Public Member Functions
Construction
	OpalUdpSsEndPoint (OpalManager &manager, const char *prefix="udpss")
	~OpalUdpSsEndPoint ()
Overrides from OpalEndPoint
virtual BOOL	MakeConnection (OpalCall &call, const PString &party, void *userData=NULL)
virtual OpalMediaFormatList	GetMediaFormats () const
Customisation call backs
virtual OpalUdpSsConnection *	CreateConnection (OpalCall &call, void *userData, const PString &token)
User Interface operations
PSafePtr< OpalUdpSsConnection >	GetUdpSsConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)
virtual PString	OnGetDestination (const OpalUdpSsConnection &connection)=0
virtual void	OnShowIncoming (const OpalUdpSsConnection &connection)=0
virtual void	AcceptIncomingConnection (const PString &connectionToken)
virtual BOOL	OnShowOutgoing (const OpalUdpSsConnection &connection)=0
virtual BOOL	OnShowUserInput (const OpalUdpSsConnection &connection, const PString &indication)
Protected Member Functions
PString	MakeToken ()
Protected Attributes
PAtomicInteger	connectionTokenIndex

---

Detailed Description

UDP based Sound System endpoint for Opal

---

Constructor & Destructor Documentation

OpalUdpSsEndPoint::OpalUdpSsEndPoint (  OpalManager &  manager, const char *  prefix = "udpss" )

Create a new endpoint. Parameters: prefix  Manager of all endpoints. Prefix for URL style address strings

OpalUdpSsEndPoint::~OpalUdpSsEndPoint (   )

Destroy endpoint.

---

Member Function Documentation

void OpalUdpSsEndPoint::AcceptIncomingConnection (  const PString &  connectionToken  )  [virtual]

Accept the incoming connection. Parameters: token  Token of connection to accept call

OpalUdpSsConnection * OpalUdpSsEndPoint::CreateConnection (  OpalCall &  call, void *  userData, const PString &  token )  [virtual]

Create a connection for the UdpSs endpoint. The default implementation is to create a OpalUdpSsConnection. Parameters: userData  Owner of connection newToken  Arbitrary data to pass to connection

OpalMediaFormatList OpalUdpSsEndPoint::GetMediaFormats (   )  const [virtual]

Get the data formats this endpoint is capable of operating. This provides a list of media data format names that may be used by an OpalMediaStream may be created by a connection from this endpoint. Note that a specific connection may not actually support all of the media formats returned here, but should return no more. The default behaviour is pure.

PSafePtr< OpalUdpSsConnection > OpalUdpSsEndPoint::GetUdpSsConnectionWithLock (  const PString &  token, PSafetyMode  mode = PSafeReadWrite )

Find a connection that uses the specified token. This searches the endpoint for the connection that contains the token as provided by functions such as MakeConnection(). Parameters: mode  Token to identify connection

BOOL OpalUdpSsEndPoint::MakeConnection (  OpalCall &  call, const PString &  party, void *  userData = NULL )  [virtual]

Set up a connection to a remote party. This is called from the OpalManager::MakeConnection() function once it has determined that this is the endpoint for the protocol. The general form for this party parameter is: [proto:][alias@][transport$]address[:port] where the various fields will have meanings specific to the endpoint type. For example, with H.323 it could be "h323:Fred@site.com" which indicates a user Fred at gatekeeper size.com. Whereas for the PSTN endpoint it could be "pstn:5551234" which is to call 5551234 on the first available PSTN line. The proto field is optional when passed to a specific endpoint. If it is present, however, it must agree with the endpoints protocol name or FALSE is returned. This function usually returns almost immediately with the connection continuing to occur in a new background thread. If FALSE is returned then the connection could not be established. For example if a PSTN endpoint is used and the assiciated line is engaged then it may return immediately. Returning a non-NULL value does not mean that the connection will succeed, only that an attempt is being made. The default behaviour is pure. Parameters: remoteParty  Owner of connection userData  Remote party to call Arbitrary data to pass to connection

PString OpalUdpSsEndPoint::MakeToken (   )  [protected]

Turn the counter into a unique token string for this conenction

virtual PString OpalUdpSsEndPoint::OnGetDestination (  const OpalUdpSsConnection &  connection  )  [pure virtual]

Call back to get the destination for outgoing call. If FALSE is returned the call is aborted. The default implementation is pure. Parameters: connection  Connection having event Implemented in MyUdpSsEndPoint.

virtual void OpalUdpSsEndPoint::OnShowIncoming (  const OpalUdpSsConnection &  connection  )  [pure virtual]

Call back to indicate that remote is ringing. If FALSE is returned the call is aborted. The default implementation is pure. Parameters: connection  Connection having event Implemented in MyUdpSsEndPoint.

virtual BOOL OpalUdpSsEndPoint::OnShowOutgoing (  const OpalUdpSsConnection &  connection  )  [pure virtual]

Call back to indicate that remote is ringing. If FALSE is returned the call is aborted. The default implementation is pure. Parameters: connection  Connection having event Implemented in MyUdpSsEndPoint.

BOOL OpalUdpSsEndPoint::OnShowUserInput (  const OpalUdpSsConnection &  connection, const PString &  indication )  [virtual]

Call back to indicate that the remote user has indicated something. If FALSE is returned the call is aborted. The default implementation does nothing. Parameters: indication  Connection having event

---

Member Data Documentation

PAtomicInteger OpalUdpSsEndPoint::connectionTokenIndex [protected]

Counter, which is used to create unique UDP connection tokens

---

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

• udpep.h
• udpep.cxx

---