OPAL  Version 3.10.10
OpalFaxEndPoint Class Reference

#include <t38proto.h>

Inheritance diagram for OpalFaxEndPoint:
OpalLocalEndPoint OpalEndPoint

Public Member Functions

Construction
 OpalFaxEndPoint (OpalManager &manager, const char *g711Prefix="fax", const char *t38Prefix="t38")
 
 ~OpalFaxEndPoint ()
 
Overrides from OpalEndPoint
virtual PSafePtr< OpalConnectionMakeConnection (OpalCall &call, const PString &party, void *userData=NULL, unsigned int options=0, OpalConnection::StringOptions *stringOptions=NULL)
 
virtual OpalMediaFormatList GetMediaFormats () const
 
Fax specific operations
virtual bool IsAvailable () const
 
virtual OpalFaxConnectionCreateConnection (OpalCall &call, void *userData, OpalConnection::StringOptions *stringOptions, const PString &filename, bool receiving, bool disableT38)
 
virtual void OnFaxCompleted (OpalFaxConnection &connection, bool failed)
 
Member variable access
const PString & GetDefaultDirectory () const
 
void SetDefaultDirectory (const PString &dir)
 
const PString & GetT38Prefix () const
 
- Public Member Functions inherited from OpalLocalEndPoint
 OpalLocalEndPoint (OpalManager &manager, const char *prefix="local")
 
 ~OpalLocalEndPoint ()
 
PSafePtr< OpalLocalConnectionGetLocalConnectionWithLock (const PString &token, PSafetyMode mode=PSafeReadWrite)
 
virtual OpalLocalConnectionCreateConnection (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)
 
- 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
 
OpalListenerFindListener (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< OpalConnectionGetConnectionWithLock (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="#\", 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 ()
 
OpalManagerGetManager () const
 
const PString & GetPrefixName () const
 
PBoolean HasAttribute (Attributes opt) const
 
WORD GetDefaultSignalPort () const
 
const OpalProductInfoGetProductInfo () 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::StringOptionsGetDefaultStringOptions () 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

PString m_t38Prefix
 
PDirectory m_defaultDirectory
 
- Protected Attributes inherited from OpalLocalEndPoint
bool m_deferredAlerting
 
bool m_deferredAnswer
 
Synchronicity m_defaultAudioSynchronicity
 
Synchronicity m_defaultVideoSourceSynchronicity
 
- Protected Attributes inherited from OpalEndPoint
OpalManagermanager
 
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
 

Additional Inherited Members

- Public Types inherited from OpalLocalEndPoint
enum  Synchronicity { e_Synchronous, e_Asynchronous, e_SimulateSyncronous }
 
- Public Types inherited from OpalEndPoint
enum  Attributes { CanTerminateCall = 1, SupportsE164 = 2 }
 
- Protected Member Functions inherited from OpalEndPoint
OpalConnectionAddConnection (OpalConnection *connection)
 

Detailed Description

Fax Endpoint. This class represents connection that can take a standard group 3 fax TIFF file and produce either T.38 packets or actual tones represented by a stream of PCM. For T.38 it is expected the second connection in the call supports T.38 e.g. SIP or H.323. If PCM is being used then the second connection may be anything that supports PCM, such as SIP or H.323 using G.711 codec or OpalLineEndpoint which could the send the TIFF file to a physical fax machine.

Relies on the presence of the spandsp plug in to do the hard work.

Constructor & Destructor Documentation

◆ OpalFaxEndPoint()

OpalFaxEndPoint::OpalFaxEndPoint ( OpalManager manager,
const char *  g711Prefix = "fax",
const char *  t38Prefix = "t38" 
)

Create a new endpoint.

Parameters
managerManager of all endpoints.
g711PrefixPrefix for URL style address strings
t38PrefixPrefix for URL style address strings

◆ ~OpalFaxEndPoint()

OpalFaxEndPoint::~OpalFaxEndPoint ( )

Destroy endpoint.

Member Function Documentation

◆ CreateConnection()

virtual OpalFaxConnection* OpalFaxEndPoint::CreateConnection ( OpalCall call,
void *  userData,
OpalConnection::StringOptions stringOptions,
const PString &  filename,
bool  receiving,
bool  disableT38 
)
virtual

Create a connection for the fax endpoint.

Parameters
callOwner of connection
userDataArbitrary data to pass to connection
stringOptionsOptions to pass to connection
filenamefilename to send/receive
receivingFlag for receiving/sending fax
disableT38Flag to disable use of T.38

◆ GetDefaultDirectory()

const PString& OpalFaxEndPoint::GetDefaultDirectory ( ) const
inline

Get the default directory for received faxes.

References m_defaultDirectory.

◆ GetMediaFormats()

virtual OpalMediaFormatList OpalFaxEndPoint::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.

Reimplemented from OpalLocalEndPoint.

◆ GetT38Prefix()

const PString& OpalFaxEndPoint::GetT38Prefix ( ) const
inline

References m_t38Prefix.

◆ IsAvailable()

virtual bool OpalFaxEndPoint::IsAvailable ( ) const
virtual

Determine if the fax plug in is available, that is fax system can be used.

◆ MakeConnection()

virtual PSafePtr<OpalConnection> OpalFaxEndPoint::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
callOwner of connection
partyRemote party to call
userDataArbitrary data to pass to connection
optionsoptions to pass to conneciton
stringOptionsOptions to pass to connection

Reimplemented from OpalLocalEndPoint.

◆ OnFaxCompleted()

virtual void OpalFaxEndPoint::OnFaxCompleted ( OpalFaxConnection connection,
bool  failed 
)
virtual

Fax transmission/receipt completed. Default behaviour releases the connection.

Parameters
connectionConnection that completed.
failedFax ended with failure

◆ SetDefaultDirectory()

void OpalFaxEndPoint::SetDefaultDirectory ( const PString &  dir)
inline

Set the default directory for received faxes.

Parameters
dirNew directory for fax reception

References m_defaultDirectory.

Field Documentation

◆ m_defaultDirectory

PDirectory OpalFaxEndPoint::m_defaultDirectory
protected

◆ m_t38Prefix

PString OpalFaxEndPoint::m_t38Prefix
protected

Referenced by GetT38Prefix().


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