OpalLocalEndPoint Class Reference

`#include <localep.h>`

Inheritance diagram for OpalLocalEndPoint:

## Public Member Functions

Construction
| OpalLocalEndPoint (OpalManager &manager, const char *prefix="local")
| ~OpalLocalEndPoint ()
Overrides from OpalEndPoint
virtual OpalMediaFormatList | GetMediaFormats () const
virtual PSafePtr< OpalConnection > | MakeConnection (OpalCall &call, const PString &party, void *userData=NULL, unsigned int options=0, OpalConnection::StringOptions *stringOptions=NULL)
Public Member Functions inherited from OpalEndPoint
| OpalEndPoint (OpalManager &manager, const PCaselessString &prefix, unsigned attributes)
| ~OpalEndPoint ()
virtual void | ShutDown ()
void | PrintOn (ostream &strm) const
PBoolean | StartListeners (const PStringArray &interfaces)
PBoolean | StartListener (const OpalTransportAddress &iface)
PBoolean | StartListener (OpalListener *listener)
virtual PStringArray | GetDefaultListeners () const
virtual PString | GetDefaultTransport () const
OpalListener * | FindListener (const OpalTransportAddress &iface)
bool | FindListenerForProtocol (const char *proto, OpalTransportAddress &addr)
PBoolean | StopListener (const OpalTransportAddress &iface)
PBoolean | RemoveListener (OpalListener *listener)
OpalTransportAddressArray | GetInterfaceAddresses (PBoolean excludeLocalHost=true, const OpalTransport *associatedTransport=NULL)
| PDECLARE_NOTIFIER (PThread, OpalEndPoint, ListenerCallback)
virtual PBoolean | NewIncomingConnection (OpalTransport *transport)
virtual void | OnNewConnection (OpalCall &call, OpalConnection &connection)
virtual PBoolean | OnSetUpConnection (OpalConnection &connection)
virtual PBoolean | OnIncomingConnection (OpalConnection &connection, unsigned options, OpalConnection::StringOptions *stringOptions)
virtual void | OnProceeding (OpalConnection &connection)
virtual void | OnAlerting (OpalConnection &connection)
virtual OpalConnection::AnswerCallResponse | OnAnswerCall (OpalConnection &connection, const PString &caller)
virtual void | OnConnected (OpalConnection &connection)
virtual void | OnEstablished (OpalConnection &connection)
virtual void | OnReleased (OpalConnection &connection)
virtual void | OnHold (OpalConnection &connection, bool fromRemote, bool onHold)
virtual void | OnHold (OpalConnection &connection)
virtual PBoolean | OnForwarded (OpalConnection &connection, const PString &remoteParty)
virtual bool | OnTransferNotify (OpalConnection &connection, const PStringToString &info)
virtual PBoolean | ClearCall (const PString &token, OpalConnection::CallEndReason reason=OpalConnection::EndedByLocalUser, PSyncPoint *sync=NULL)
virtual PBoolean | ClearCallSynchronous (const PString &token, OpalConnection::CallEndReason reason=OpalConnection::EndedByLocalUser, PSyncPoint *sync=NULL)
virtual void | ClearAllCalls (OpalConnection::CallEndReason reason=OpalConnection::EndedByLocalUser, PBoolean wait=true)
PSafePtr< OpalConnection > | GetConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)
template<class ConnClass >
PSafePtr< ConnClass > | GetConnectionWithLockAs (const PString &token, PSafetyMode mode=PSafeReadWrite)
PStringList | GetAllConnections ()
PINDEX | GetConnectionCount () const
virtual PBoolean | HasConnection (const PString &token)
virtual void | DestroyConnection (OpalConnection *connection)
virtual void | AdjustMediaFormats (bool local, const OpalConnection &connection, OpalMediaFormatList &mediaFormats) const
virtual PBoolean | OnOpenMediaStream (OpalConnection &connection, OpalMediaStream &stream)
virtual void | OnClosedMediaStream (const OpalMediaStream &stream)
virtual PBoolean | CreateVideoInputDevice (const OpalConnection &connection, const OpalMediaFormat &mediaFormat, PVideoInputDevice *&device, PBoolean &autoDelete)
virtual PBoolean | CreateVideoOutputDevice (const OpalConnection &connection, const OpalMediaFormat &mediaFormat, PBoolean preview, PVideoOutputDevice *&device, PBoolean &autoDelete)
virtual void | OnUserInputString (OpalConnection &connection, const PString &value)
virtual void | OnUserInputTone (OpalConnection &connection, char tone, int duration)
virtual PString | ReadUserInput (OpalConnection &connection, const char *terminators="#\r\n", unsigned lastDigitTimeout=4, unsigned firstDigitTimeout=30)
virtual PBoolean | Message (const PString &to, const PString &body)
virtual PBoolean | Message (const PURL &to, const PString &type, const PString &body, PURL &from, PString &conversationId)
virtual PBoolean | Message (OpalIM &Message)
virtual void | OnMessageReceived (const OpalIM &message)
virtual void | OnMWIReceived (const PString &party, OpalManager::MessageWaitingType type, const PString &extraInfo)
virtual PBoolean | GarbageCollection ()
OpalManager & | GetManager () const
const PString & | GetPrefixName () const
PBoolean | HasAttribute (Attributes opt) const
WORD | GetDefaultSignalPort () const
const OpalProductInfo & | GetProductInfo () const
void | SetProductInfo (const OpalProductInfo &info)
const PString & | GetDefaultLocalPartyName () const
virtual void | SetDefaultLocalPartyName (const PString &name)
const PString & | GetDefaultDisplayName () const
void | SetDefaultDisplayName (const PString &name)
unsigned | GetInitialBandwidth () const
void | SetInitialBandwidth (unsigned bandwidth)
const OpalListenerList & | GetListeners () const
const OpalConnection::StringOptions & | GetDefaultStringOptions () const
void | SetDefaultStringOptions (const OpalConnection::StringOptions &opts)
void | SetDefaultStringOption (const PCaselessString &key, const PString &data)
OpalConnection::SendUserInputModes | GetSendUserInputMode () const
void | SetSendUserInputMode (OpalConnection::SendUserInputModes mode)

## Protected Attributes

bool | m_deferredAlerting
bool | m_deferredAnswer
Synchronicity | m_defaultAudioSynchronicity
Synchronicity | m_defaultVideoSourceSynchronicity
Protected Attributes inherited from OpalEndPoint
OpalManager & | manager
PCaselessString | prefixName
unsigned | attributeBits
WORD | defaultSignalPort
PINDEX | m_maxSizeUDP
OpalProductInfo | productInfo
PString | defaultLocalPartyName
PString | defaultDisplayName
unsigned | initialBandwidth
OpalConnection::StringOptions | m_defaultStringOptions
OpalConnection::SendUserInputModes | defaultSendUserInputMode
OpalListenerList | listeners
OpalEndPoint::ConnectionDict | connectionsActive
PMutex | inUseFlag

## Customisation call backs

enum | Synchronicity { e_Synchronous, e_Asynchronous, e_SimulateSyncronous }
PSafePtr< OpalLocalConnection > | GetLocalConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)
virtual OpalLocalConnection * | CreateConnection (OpalCall &call, void *userData, unsigned options, OpalConnection::StringOptions *stringOptions)
virtual bool | OnOutgoingSetUp (const OpalLocalConnection &connection)
virtual bool | OnOutgoingCall (const OpalLocalConnection &connection)
virtual bool | OnIncomingCall (OpalLocalConnection &connection)
virtual bool | AlertingIncomingCall (const PString &token, OpalConnection::StringOptions *options=NULL)
virtual bool | AcceptIncomingCall (const PString &token, OpalConnection::StringOptions *options=NULL)
virtual bool | RejectIncomingCall (const PString &token, const OpalConnection::CallEndReason &reason=OpalConnection::EndedByAnswerDenied)
virtual bool | OnUserInput (const OpalLocalConnection &connection, const PString &indication)
virtual bool | OnReadMediaFrame (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, RTP_DataFrame &frame)
virtual bool | OnWriteMediaFrame (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, RTP_DataFrame &frame)
virtual bool | OnReadMediaData (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, void *data, PINDEX size, PINDEX &length)
virtual bool | OnWriteMediaData (const OpalLocalConnection &connection, const OpalMediaStream &mediaStream, const void *data, PINDEX length, PINDEX &written)
virtual Synchronicity | GetSynchronicity (const OpalMediaFormat &mediaFormat, bool isSource) const
Synchronicity | GetDefaultAudioSynchronicity () const
void | SetDefaultAudioSynchronicity (Synchronicity sync)
Synchronicity | GetDefaultVideoSourceSynchronicity () const
void | SetDefaultVideoSourceSynchronicity (Synchronicity sync)
bool | IsDeferredAlerting () const
void | SetDeferredAlerting (bool defer)
bool | IsDeferredAnswer () const
void | SetDeferredAnswer (bool defer)

## Additional Inherited Members

Public Types inherited from OpalEndPoint
enum | Attributes { CanTerminateCall = 1, SupportsE164 = 2 }
Protected Member Functions inherited from OpalEndPoint
OpalConnection * | AddConnection (OpalConnection *connection)

## Detailed Description

Local EndPoint. This class represents an endpoint on the local machine that can receive media via virtual functions.

## Member Enumeration Documentation

enum OpalLocalEndPoint::Synchronicity

Indicate the synchronous mode for I/O. This indicates that the OnReadMediaXXX and OnWriteMediaXXX functions will execute blocking to the correct real time synchronisation. If GetSynchronicity() returns e_Synchronous, then, for example, when OnWriteMediaData() is sent 320 bytes of PCM data, it will block for 20 milliseconds.

If GetSynchronicity() returns e_SimulateSyncronous, then the system will try and simulate the correct timing using the operating system sleep function. This is not desirable as this function is notoriously inaccurate, and OPAL does it's best to compensate, but very often there is no other choice.

Note, it is important for the correct oeprating of the jitter buffer that one of the above two modes is used for audio.

If GetSynchronicity() returns e_Asynchronous, then the system will indicate that blocking is not required in any way. For example, when playing video, this is done as fast as data comes in from the network and there is no real time pacing required.

Enumerator
e_Synchronous | Functions will block for correct real time.
e_Asynchronous | Functions will not block, and do not require any real time handling.
e_SimulateSyncronous | Functions wlll not block, but do require real time handling.

## Constructor & Destructor Documentation

OpalLocalEndPoint::OpalLocalEndPoint | ( | OpalManager & | manager,
|  | const char * | prefix = `"local"`
| ) |  |

Create a new endpoint.

Parameters

  manager | Manager of all endpoints.
  prefix | Prefix for URL style address strings

OpalLocalEndPoint::~OpalLocalEndPoint | ( |  | ) |

Destroy endpoint.

## Member Function Documentation

virtual bool OpalLocalEndPoint::AcceptIncomingCall | ( | const PString & | token,
|  | OpalConnection::StringOptions * | options = `NULL`
| ) |  |

virtual

Accept the incoming connection. Returns false if the connection token does not correspond to a valid connection.

Parameters

  token | Token of connection to accept call
  options | Optional string optiosn to apply

virtual bool OpalLocalEndPoint::AlertingIncomingCall | ( | const PString & | token,
|  | OpalConnection::StringOptions * | options = `NULL`
| ) |  |

virtual

Indicate alerting for the incoming connection. Returns false if the connection token does not correspond to a valid connection.

Parameters

  token | Token of connection to indicate alerting
  options | Optional string optiosn to apply

virtual OpalLocalConnection* OpalLocalEndPoint::CreateConnection | ( | OpalCall & | call,
|  | void * | userData,
|  | unsigned | options,
|  | OpalConnection::StringOptions * | stringOptions
| ) |  |

virtual

Create a connection for the PCSS endpoint. The default implementation is to create a OpalLocalConnection.

Parameters

  call | Owner of connection
  userData | Arbitrary data to pass to connection
  options | Option bit mask to pass to connection
  stringOptions | Options to pass to connection

Synchronicity OpalLocalEndPoint::GetDefaultAudioSynchronicity | ( |  | ) | const

inline

Get default synchronous mode for audio sources and sinks.

References m_defaultAudioSynchronicity.

Synchronicity OpalLocalEndPoint::GetDefaultVideoSourceSynchronicity | ( |  | ) | const

inline

Get default synchronous mode for video sources.

References m_defaultVideoSourceSynchronicity.

PSafePtr<OpalLocalConnection> OpalLocalEndPoint::GetLocalConnectionWithLock | ( | const PString & | token,
|  | PSafetyMode | mode = `PSafeReadWrite`
| ) |  |

inline

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(). If not then it attempts to use the token as a OpalCall token and find a connection of the same class.

Parameters

  token | Token to identify connection
  mode | Lock mode

virtual OpalMediaFormatList OpalLocalEndPoint::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 returns the most basic media formats, PCM audio and YUV420P video.

Implements OpalEndPoint.

Reimplemented in OpalMixerEndPoint, OpalIVREndPoint, and OpalFaxEndPoint.

virtual Synchronicity OpalLocalEndPoint::GetSynchronicity | ( | const OpalMediaFormat & | mediaFormat,
|  | bool | isSource
| ) |  | const

virtual

Indicate the I/O synchronous mode. See Synchronicity for more details.

Default behaviour returns m_defaultAudioSynchronicity (initially e_Synchronous) when is audio source or sink, m_defaultVideoSourceSynchronicity (initially e_Synchronous) when a video source, e_Asynchronous in all other cases.

Parameters

  mediaFormat | Media format for stream being opened.
  isSource | Stream is a a source

bool OpalLocalEndPoint::IsDeferredAlerting | ( |  | ) | const

inline

Indicate OnAlerting() is be deferred or immediate.

References m_deferredAlerting.

bool OpalLocalEndPoint::IsDeferredAnswer | ( |  | ) | const

inline

Indicate AcceptIncomingCall() execution is be deferred or immediate on OnIncomingCall().

References m_deferredAnswer.

virtual PSafePtr<OpalConnection> OpalLocalEndPoint::MakeConnection | ( | OpalCall & | call,
|  | const PString & | party,
|  | void * | userData = `NULL`,
|  | unsigned int | options = `0`,
|  | OpalConnection::StringOptions * | stringOptions = `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

  call | Owner of connection
  party | Remote party to call
  userData | Arbitrary data to pass to connection
  options | options to pass to conneciton
  stringOptions | Options to pass to connection

Implements OpalEndPoint.

Reimplemented in OpalFaxEndPoint, and OpalIVREndPoint.

virtual bool OpalLocalEndPoint::OnIncomingCall | ( | OpalLocalConnection & | connection | ) |

virtual

Call back to indicate that there is an incoming call. Note this function should not block or it will impede the operation of the stack.

The default implementation returns true;

Returns
  false is returned the call is aborted with status of EndedByLocalBusy.

Parameters

  connection | Connection having event

Reimplemented in OpalPCSSEndPoint.

virtual bool OpalLocalEndPoint::OnOutgoingCall | ( | const OpalLocalConnection & | connection | ) |

virtual

Call back to indicate that remote is ringing. If false is returned the call is aborted.

The default implementation does nothing.

Parameters

  connection | Connection having event

Reimplemented in OpalPCSSEndPoint.

virtual bool OpalLocalEndPoint::OnOutgoingSetUp | ( | const OpalLocalConnection & | connection | ) |

virtual

Call back just before remote is contacted. If false is returned the call is aborted with EndedByNoAccept.

The default implementation returns true.

Parameters

  connection | Connection having event

virtual bool OpalLocalEndPoint::OnReadMediaData | ( | const OpalLocalConnection & | connection,
|  | const OpalMediaStream & | mediaStream,
|  | void * | data,
|  | PINDEX | size,
|  | PINDEX & | length
| ) |  |

virtual

Call back to get media data for transmission. If false is returned the media stream will be closed.

Care with the handling of real time is rqeuired, see GetSynchronicity for more details.

The default implementation returns false.

Parameters

  connection | Connection for media
  mediaStream | Media stream data is required for
  data | Data to send
  size | Maximum size of data buffer
  length | Number of bytes placed in buffer

virtual bool OpalLocalEndPoint::OnReadMediaFrame | ( | const OpalLocalConnection & | connection,
|  | const OpalMediaStream & | mediaStream,
|  | RTP_DataFrame & | frame
| ) |  |

virtual

Call back to get media data for transmission. If false is returned then OnReadMediaData() is called.

Care with the handling of real time is rqeuired, see GetSynchronicity for more details.

The default implementation returns false.

Parameters

  connection | Connection for media
  mediaStream | Media stream data is required for
  frame | RTP frame for data

virtual bool OpalLocalEndPoint::OnUserInput | ( | const OpalLocalConnection & | 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

  connection | Connection having event
  indication | User input received

Reimplemented in OpalPCSSEndPoint.

virtual bool OpalLocalEndPoint::OnWriteMediaData | ( | const OpalLocalConnection & | connection,
|  | const OpalMediaStream & | mediaStream,
|  | const void * | data,
|  | PINDEX | length,
|  | PINDEX & | written
| ) |  |

virtual

Call back to handle received media data. If false is returned the media stream will be closed.

Care with the handling of real time is rqeuired, see GetSynchronicity for more details.

The default implementation returns false.

Parameters

  connection | Connection for media
  mediaStream | Media stream data is required for
  data | Data received
  length | Amount of data available to write
  written | Amount of data written

virtual bool OpalLocalEndPoint::OnWriteMediaFrame | ( | const OpalLocalConnection & | connection,
|  | const OpalMediaStream & | mediaStream,
|  | RTP_DataFrame & | frame
| ) |  |

virtual

Call back to handle received media data. If false is returned then OnWriteMediaData() is called.

Care with the handling of real time is rqeuired, see GetSynchronicity for more details.

The default implementation returns false.

Parameters

  connection | Connection for media
  mediaStream | Media stream data is required for
  frame | RTP frame for data

virtual bool OpalLocalEndPoint::RejectIncomingCall | ( | const PString & | token,
|  | const OpalConnection::CallEndReason & | reason = `OpalConnection::EndedByAnswerDenied`
| ) |  |

virtual

Reject the incoming connection. Returns false if the connection token does not correspond to a valid connection.

Parameters

  token | Token of connection to accept call
  reason | Reason for rejecting the call

void OpalLocalEndPoint::SetDefaultAudioSynchronicity | ( | Synchronicity | sync | ) |

inline

Set default synchronous mode for audio sources and sinks.

References m_defaultAudioSynchronicity.

void OpalLocalEndPoint::SetDefaultVideoSourceSynchronicity | ( | Synchronicity | sync | ) |

inline

Set default synchronous mode for video sources.

References m_defaultVideoSourceSynchronicity.

void OpalLocalEndPoint::SetDeferredAlerting | ( | bool | defer | ) |

inline

Indicate OnAlerting() is be deferred or immediate.

References m_deferredAlerting.

void OpalLocalEndPoint::SetDeferredAnswer | ( | bool | defer | ) |

inline

Indicate AcceptIncomingCall() execution is be deferred or immediate on OnIncomingCall().

References m_deferredAnswer.

## Field Documentation

Synchronicity OpalLocalEndPoint::m_defaultAudioSynchronicity

protected

Referenced by GetDefaultAudioSynchronicity(), and SetDefaultAudioSynchronicity().

Synchronicity OpalLocalEndPoint::m_defaultVideoSourceSynchronicity

protected

Referenced by GetDefaultVideoSourceSynchronicity(), and SetDefaultVideoSourceSynchronicity().

bool OpalLocalEndPoint::m_deferredAlerting

protected

Referenced by IsDeferredAlerting(), and SetDeferredAlerting().

bool OpalLocalEndPoint::m_deferredAnswer

protected

Referenced by IsDeferredAnswer(), and SetDeferredAnswer().

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

- localep.h