OpalFaxConnection Class Reference

#include <t38proto.h>

Inheritance diagram for OpalFaxConnection:
OpalConnection OpalT38Connection

List of all members.

Public Member Functions

Construction

 OpalFaxConnection (OpalCall &call, OpalFaxEndPoint &endpoint, const PString &filename, bool receive, const PString &_token, OpalConnection::StringOptions *stringOptions=NULL)
 ~OpalFaxConnection ()
Overrides from OpalConnection

virtual bool IsNetworkConnection () const
virtual PBoolean SetUpConnection ()
virtual PBoolean SetAlerting (const PString &calleeName, PBoolean withMedia)
virtual OpalMediaFormatList GetMediaFormats () const
virtual void ApplyStringOptions (OpalConnection::StringOptions &stringOptions)
virtual OpalMediaStreamCreateMediaStream (const OpalMediaFormat &mediaFormat, unsigned sessionID, PBoolean isSource)
virtual void AdjustMediaFormats (OpalMediaFormatList &mediaFormats) const
New operations

virtual void AcceptIncoming ()
virtual void OnFaxCompleted (bool failed)
bool IsReceive () const

Protected Attributes

OpalFaxEndPointm_endpoint
PString m_filename
bool m_receive
PString m_stationId

Detailed Description

Fax Connection


Constructor & Destructor Documentation

OpalFaxConnection::OpalFaxConnection ( OpalCall call,
OpalFaxEndPoint endpoint,
const PString &  filename,
bool  receive,
const PString &  _token,
OpalConnection::StringOptions stringOptions = NULL 
)

Create a new endpoint.

Parameters:
call Owner calll for connection
endpoint Owner endpoint for connection
filename filename to send/receive
receive true if receiving a fax
_token token for connection
OpalFaxConnection::~OpalFaxConnection (  ) 

Destroy endpoint.


Member Function Documentation

virtual void OpalFaxConnection::AcceptIncoming (  )  [virtual]

Accept the incoming connection.

virtual void OpalFaxConnection::AdjustMediaFormats ( OpalMediaFormatList mediaFormats  )  const [virtual]

Adjust media formats available on a connection. This is called by a connection after it has called OpalCall::GetMediaFormats() to get all media formats that it can use so that an application may remove or reorder the media formats before they are used to open media streams.

The default behaviour calls the OpalEndPoint function of the same name.

Reimplemented from OpalConnection.

virtual void OpalFaxConnection::ApplyStringOptions ( OpalConnection::StringOptions stringOptions  )  [virtual]

Reimplemented from OpalConnection.

Reimplemented in OpalT38Connection.

virtual OpalMediaStream* OpalFaxConnection::CreateMediaStream ( const OpalMediaFormat mediaFormat,
unsigned  sessionID,
PBoolean  isSource 
) [virtual]

Create 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.

Reimplemented from OpalConnection.

Reimplemented in OpalT38Connection.

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

Reimplemented from OpalConnection.

Reimplemented in OpalT38Connection.

virtual bool OpalFaxConnection::IsNetworkConnection (  )  const [inline, virtual]

Get indication of connection being to a "network". This indicates the if the connection may be regarded as a "network" connection. The distinction is about if there is a concept of a "remote" party being connected to and is best described by example: sip, h323, iax and pstn are all "network" connections as they connect to something "remote". While pc, pots and ivr are not as the entity being connected to is intrinsically local.

Implements OpalConnection.

bool OpalFaxConnection::IsReceive (  )  const [inline]

Get receive fax flag.

References m_receive.

virtual void OpalFaxConnection::OnFaxCompleted ( bool  failed  )  [virtual]

Fax transmission/receipt completed. Default behaviour calls equivalent function on OpalFaxEndPoint.

Parameters:
failed Fax ended with failure
virtual PBoolean OpalFaxConnection::SetAlerting ( const PString &  calleeName,
PBoolean  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:
calleeName Name of endpoint being alerted.
withMedia Open media with alerting

Implements OpalConnection.

virtual PBoolean OpalFaxConnection::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.

Implements OpalConnection.


Member Data Documentation

PString OpalFaxConnection::m_filename [protected]
bool OpalFaxConnection::m_receive [protected]

Referenced by IsReceive().

PString OpalFaxConnection::m_stationId [protected]

The documentation for this class was generated from the following file:
Generated on Wed Jul 7 10:24:45 2010 for OPAL by  doxygen 1.6.3