OpalFaxEndPoint Class Reference

#include <t38proto.h>

Inheritance diagram for OpalFaxEndPoint:

List of all members.

Public Member Functions
virtual BOOL	MakeConnection (OpalCall &call, const PString &party, void *userData=NULL, unsigned int options=0, OpalConnection::StringOptions *stringOptions=NULL)
virtual OpalFaxConnection *	CreateConnection (OpalCall &call, const PString &filename, BOOL receive, void *userData=NULL, OpalConnection::StringOptions *stringOptions=NULL)
virtual OpalMediaFormatList	GetMediaFormats () const
virtual PString	MakeToken ()
User Interface operations
virtual void	AcceptIncomingConnection (const PString &connectionToken)
virtual void	OnPatchMediaStream (const OpalFaxConnection &connection, BOOL isSource, OpalMediaPatch &patch)

---

Detailed Description

Fax Endpoint.

---

Constructor & Destructor Documentation

OpalFaxEndPoint::OpalFaxEndPoint	(	OpalManager &	manager,
		const char *	prefix = "fax"
	)

Create a new endpoint.

Parameters:

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

OpalFaxEndPoint::~OpalFaxEndPoint

(

)

Destroy endpoint.

OpalFaxEndPoint::OpalFaxEndPoint	(	OpalManager &	manager,
		const char *	prefix = "fax"
	)

Create a new endpoint.

Parameters:

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

OpalFaxEndPoint::~OpalFaxEndPoint

(

)

Destroy endpoint.

---

Member Function Documentation

virtual BOOL 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:

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

Implements OpalEndPoint.

virtual OpalFaxConnection* OpalFaxEndPoint::CreateConnection	(	OpalCall &	call,
		const PString &	filename,
		BOOL	receive,
		void *	userData = NULL,
		OpalConnection::StringOptions *	stringOptions = NULL
	)			[virtual]

Create a connection for the fax endpoint.

Parameters:

call	Owner of connection
filename	filename to send/receive
userData	Arbitrary data to pass to connection

Reimplemented in OpalT38EndPoint.

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.

The default behaviour is pure.

Implements OpalEndPoint.

Reimplemented in OpalT38EndPoint.

virtual PString OpalFaxEndPoint::MakeToken

(

)

[virtual]

Reimplemented in OpalT38EndPoint.

virtual void OpalFaxEndPoint::AcceptIncomingConnection

(

const PString &

connectionToken

)

[virtual]

Accept the incoming connection.

Parameters:

connectionToken

Token of connection to accept call

virtual void OpalFaxEndPoint::OnPatchMediaStream	(	const OpalFaxConnection &	connection,
		BOOL	isSource,
		OpalMediaPatch &	patch
	)			[virtual]

Call back when patching a media stream. This function is called when a connection has created a new media patch between two streams.

Parameters:

connection	Connection having new patch
isSource	Source patch
patch	New patch

---

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

• t38proto.h

---