#include <vxml.h>

Inheritance diagram for PVXMLSession:

Collaboration diagram for PVXMLSession:

Public Types
enum	TransferType { BridgedTransfer, BlindTransfer, ConsultationTransfer }

Public Types inherited from PChannel
enum	PXBlockType { PXReadBlock, PXWriteBlock, PXAcceptBlock, PXConnectBlock }

enum	Errors { NoError, NotFound, FileExists, DiskFull, AccessDenied, DeviceInUse, BadParameter, NoMemory, NotOpen, Timeout, Interrupted, BufferTooSmall, Miscellaneous, ProtocolFailure, Unavailable, NumNormalisedErrors }
	Normalised error codes. More...

enum	ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
	Error groups. More...

typedef PNotifierTemplate < PChannel::AsyncContext & >	AsyncNotifier

enum	ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Public Member Functions
	PVXMLSession (PTextToSpeech *tts=NULL, PBoolean autoDelete=false)

virtual	~PVXMLSession ()

PTextToSpeech *	SetTextToSpeech (PTextToSpeech *tts, PBoolean autoDelete=false)

PTextToSpeech *	SetTextToSpeech (const PString &ttsName)

PTextToSpeech *	GetTextToSpeech () const

void	SetCache (PVXMLCache &cache)

PVXMLCache &	GetCache ()

void	SetRecordDirectory (const PDirectory &dir)

const PDirectory &	GetRecordDirectory () const

virtual PBoolean	Load (const PString &source)

virtual PBoolean	LoadFile (const PFilePath &file, const PString &firstForm=PString::Empty())

virtual PBoolean	LoadURL (const PURL &url)

virtual PBoolean	LoadVXML (const PString &xml, const PString &firstForm=PString::Empty())

virtual PBoolean	IsLoaded () const

virtual bool	Open (const PString &mediaFormat, unsigned sampleRate=8000, unsigned channels=1)

virtual PBoolean	Close ()
	Close the channel. More...

PVXMLChannel *	GetAndLockVXMLChannel ()

void	UnLockVXMLChannel ()

PMutex &	GetSessionMutex ()

virtual PBoolean	LoadGrammar (PVXMLGrammar *grammar)

virtual PBoolean	PlayText (const PString &text, PTextToSpeech::TextType type=PTextToSpeech::Default, PINDEX repeat=1, PINDEX delay=0)

virtual PBoolean	PlayFile (const PString &fn, PINDEX repeat=1, PINDEX delay=0, PBoolean autoDelete=false)

virtual PBoolean	PlayData (const PBYTEArray &data, PINDEX repeat=1, PINDEX delay=0)

virtual PBoolean	PlayCommand (const PString &data, PINDEX repeat=1, PINDEX delay=0)

virtual PBoolean	PlayResource (const PURL &url, PINDEX repeat=1, PINDEX delay=0)

virtual PBoolean	PlayTone (const PString &toneSpec, PINDEX repeat=1, PINDEX delay=0)

virtual PBoolean	PlayElement (PXMLElement &element)

virtual PBoolean	PlaySilence (PINDEX msecs=0)

virtual PBoolean	PlaySilence (const PTimeInterval &timeout)

virtual PBoolean	PlayStop ()

virtual void	SetPause (PBoolean pause)

virtual void	GetBeepData (PBYTEArray &data, unsigned ms)

virtual void	OnUserInput (const PString &str)

PString	GetXMLError () const

virtual void	OnEndDialog ()

virtual void	OnEndSession ()

virtual bool	OnTransfer (const PString &, TransferType)

void	SetTransferComplete (bool state)

PStringToString	GetVariables () const

virtual PCaselessString	GetVar (const PString &str) const

virtual void	SetVar (const PString &ostr, const PString &val)

virtual PString	EvaluateExpr (const PString &oexpr)

bool	SetCurrentForm (const PString &id, bool fullURI)

bool	GoToEventHandler (PXMLElement &element, const PString &eventName)

PXMLElement *	FindElementWithCount (PXMLElement &parent, const PString &name, unsigned count)

virtual void	OnEndRecording (PINDEX bytesRecorded, bool timedOut)

virtual void	Trigger ()

virtual PBoolean	TraverseBlock (PXMLElement &element)

virtual PBoolean	TraverseAudio (PXMLElement &element)

virtual PBoolean	TraverseBreak (PXMLElement &element)

virtual PBoolean	TraverseValue (PXMLElement &element)

virtual PBoolean	TraverseSayAs (PXMLElement &element)

virtual PBoolean	TraverseGoto (PXMLElement &element)

virtual PBoolean	TraverseGrammar (PXMLElement &element)

virtual PBoolean	TraverseRecord (PXMLElement &element)

virtual PBoolean	TraversedRecord (PXMLElement &element)

virtual PBoolean	TraverseIf (PXMLElement &element)

virtual PBoolean	TraversedIf (PXMLElement &element)

virtual PBoolean	TraverseElseIf (PXMLElement &element)

virtual PBoolean	TraverseElse (PXMLElement &element)

virtual PBoolean	TraverseExit (PXMLElement &element)

virtual PBoolean	TraverseVar (PXMLElement &element)

virtual PBoolean	TraverseSubmit (PXMLElement &element)

virtual PBoolean	TraverseMenu (PXMLElement &element)

virtual PBoolean	TraversedMenu (PXMLElement &element)

virtual PBoolean	TraverseChoice (PXMLElement &element)

virtual PBoolean	TraverseProperty (PXMLElement &element)

virtual PBoolean	TraverseDisconnect (PXMLElement &element)

virtual PBoolean	TraverseForm (PXMLElement &element)

virtual PBoolean	TraversedForm (PXMLElement &element)

virtual PBoolean	TraversePrompt (PXMLElement &element)

virtual PBoolean	TraversedPrompt (PXMLElement &element)

virtual PBoolean	TraverseField (PXMLElement &element)

virtual PBoolean	TraversedField (PXMLElement &element)

virtual PBoolean	TraverseTransfer (PXMLElement &element)

virtual PBoolean	TraversedTransfer (PXMLElement &element)

virtual PBoolean	TraverseScript (PXMLElement &element)

__inline PVXMLChannel *	GetVXMLChannel () const

Public Member Functions inherited from PIndirectChannel
	PIndirectChannel ()
	Create a new indirect channel without any channels to redirect to. More...

	~PIndirectChannel ()
	Close the indirect channel, deleting read/write channels if desired. More...

Comparison	Compare (const PObject &obj) const
	Determine if the two objects refer to the same indirect channel. More...

virtual PString	GetName () const
	Get the name of the channel. More...

virtual P_INT_PTR	GetHandle () const
	Get the OS specific handle for the PSoundChannel. More...

virtual PBoolean	IsOpen () const
	Determine if the channel is currently open and read and write operations can be executed on it. More...

virtual PBoolean	Read (void *buf, PINDEX len)
	Low level read from the channel. More...

virtual int	ReadChar ()
	Read a single character from the channel. More...

virtual PBoolean	Write (const void *buf, PINDEX len)
	Low level write to the channel. More...

virtual PBoolean	Shutdown (ShutdownValue option)
	Close one or both of the data streams associated with a channel. More...

virtual bool	SetLocalEcho (bool localEcho)
	Set local echo mode. More...

virtual PChannel *	GetBaseReadChannel () const
	This function returns the eventual base channel for reading of a series of indirect channels provided by descendents of `PIndirectChannel`. More...

virtual PChannel *	GetBaseWriteChannel () const
	This function returns the eventual base channel for writing of a series of indirect channels provided by descendents of `PIndirectChannel`. More...

virtual bool	CloseBaseReadChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

virtual bool	CloseBaseWriteChannel ()
	Close the base channel of channel indirection using PIndirectChannel. More...

virtual PString	GetErrorText (ErrorGroup group=NumErrorGroups) const
	Get error message description. More...

PBoolean	Open (PChannel &channel)
	Set the channel for both read and write operations. More...

PBoolean	Open (PChannel *channel, PBoolean autoDelete=true)
	Set the channel for both read and write operations. More...

PBoolean	Open (PChannel readChannel, PChannel writeChannel, PBoolean autoDeleteRead=true, PBoolean autoDeleteWrite=true)
	Set the channel for both read and write operations. More...

PChannel *	Detach (ShutdownValue option=ShutdownReadAndWrite)
	Detach without closing the read/write channel. More...

PChannel *	GetReadChannel () const
	Get the channel used for read operations. More...

bool	SetReadChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
	Set the channel for read operations. More...

PChannel *	GetWriteChannel () const
	Get the channel used for write operations. More...

PBoolean	SetWriteChannel (PChannel *channel, bool autoDelete=true, bool closeExisting=false)
	Set the channel for read operations. More...

template<class ChannelClass >
ChannelClass *	FindChannel ()
	Locate a channel of a specific class in the indirect chain. More...

Public Member Functions inherited from PChannel
PBoolean	SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)
	Set error values to those specified. More...

virtual PINDEX	HashFunction () const
	Calculate a hash value for use in sets and dictionaries. More...

FILE *	FDOpen (const char *mode)
	Re-open the device using the stdio library. More...

void	SetReadTimeout (const PTimeInterval &time)
	Set the timeout for read operations. More...

PTimeInterval	GetReadTimeout () const
	Get the timeout for read operations. More...

virtual PINDEX	GetLastReadCount () const
	Get the number of bytes read by the last Read() call. More...

virtual PINDEX	SetLastReadCount (PINDEX count)

PBoolean	ReadBlock (void *buf, PINDEX len)
	Read len bytes into the buffer from the channel. More...

PString	ReadString (PINDEX len)
	Read `len` character into a string from the channel. More...

void	SetWriteTimeout (const PTimeInterval &time)
	Set the timeout for write operations to complete. More...

PTimeInterval	GetWriteTimeout () const
	Get the timeout for write operations to complete. More...

virtual PBoolean	Write (const void buf, PINDEX len, const void )
	Low level write to the channel with marker. More...

virtual PINDEX	GetLastWriteCount () const
	Get the number of bytes written by the last Write() call. More...

virtual PINDEX	SetLastWriteCount (PINDEX count)

PBoolean	WriteChar (int c)
	Write a single character to the channel. More...

PBoolean	WriteString (const PString &str)
	Write a string to the channel. More...

	~PChannel ()
	Close down the channel. More...

Errors	GetErrorCode (ErrorGroup group=NumErrorGroups) const
	Get normalised error code. More...

int	GetErrorNumber (ErrorGroup group=NumErrorGroups) const
	Get OS errro code. More...

virtual bool	ReadAsync (AsyncContext &context)
	Begin an asynchronous read from channel. More...

virtual void	OnReadComplete (AsyncContext &context)
	User callback function for when a `ReadAsync()` call has completed or timed out. More...

virtual bool	WriteAsync (AsyncContext &context)
	Begin an asynchronous write from channel. More...

virtual void	OnWriteComplete (AsyncContext &context)
	User callback function for when a WriteAsync() call has completed or timed out. More...

virtual bool	FlowControl (const void *flowData)
	Flow Control information Pass data to the channel for flowControl determination. More...

PBoolean	SetBufferSize (PINDEX newSize)
	Set the iostream buffer size for reads and writes. More...

PBoolean	SendCommandString (const PString &command)
	Send a command meta-string. More...

void	AbortCommandString ()
	Abort a command string that is in progress. More...

Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Static Public Member Functions
static PTimeInterval	StringToTime (const PString &str, int dflt=0)

Static Public Member Functions inherited from PChannel
static PString	GetErrorText (Errors lastError, int osError=0)
	Get error message description. More...

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Protected Types
enum	{ NotRecording, RecordingInProgress, RecordingComplete }

enum	{ NotTransfering, TransferInProgress, TransferFailed, TransferSuccessful, TransferCompleted }

Protected Member Functions
virtual bool	InternalLoadVXML (const PString &xml, const PString &firstForm)

virtual void	InternalStartThread ()

virtual void	InternalThreadMain ()

virtual void	InternalStartVXML ()

virtual bool	ProcessNode ()

virtual bool	ProcessEvents ()

virtual bool	NextNode (bool processChildren)

bool	ExecuteCondition (PXMLElement &element)

void	ClearBargeIn ()

void	FlushInput ()

void	SayAs (const PString &className, const PString &text)

void	SayAs (const PString &className, const PString &text, const PString &voice)

PURL	NormaliseResourceName (const PString &src)

	PDECLARE_MUTEX (m_sessionMutex)

	PDECLARE_MUTEX (m_userInputMutex)

Protected Member Functions inherited from PIndirectChannel
virtual PBoolean	OnOpen ()
	This callback is executed when the Open() function is called with open channels. More...

	PDECLARE_READ_WRITE_MUTEX (channelPointerMutex)
	Race condition prevention on closing channel. More...

Protected Member Functions inherited from PChannel
	PChannel (const PChannel &)

PChannel &	operator= (const PChannel &)

virtual PBoolean	ConvertOSError (P_INT_PTR libcReturnValue, ErrorGroup group=LastGeneralError)
	Convert an operating system error into platform independent error. More...

int	ReadCharWithTimeout (PTimeInterval &timeout)
	Read a character with specified timeout. More...

PBoolean	ReceiveCommandString (int nextChar, const PString &reply, PINDEX &pos, PINDEX start)

bool	CheckNotOpen ()

virtual int	os_errno () const

PBoolean	PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)

P_INT_PTR	GetOSHandleAsInt () const

int	PXClose ()

	PDECLARE_MUTEX (px_threadMutex)

	PDECLARE_MUTEX (px_writeMutex)

	PChannel ()
	Create the channel. More...

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PURL	m_rootURL

PTextToSpeech *	m_textToSpeech

PVXMLCache *	m_ttsCache

bool	m_autoDeleteTextToSpeech

PThread *	m_vxmlThread

bool	m_abortVXML

PSyncPoint	m_waitForEvent

PAutoPtr< PXML >	m_newXML

PString	m_lastXMLError

PString	m_newFormName

PAutoPtr< PXML >	m_currentXML

PXMLObject *	m_currentNode

bool	m_speakNodeData

bool	m_bargeIn

bool	m_bargingIn

std::map< std::string, unsigned >	m_eventCount

unsigned	m_promptCount

PVXMLGrammar *	m_grammar

char	m_defaultMenuDTMF

PStringToString	m_variables

PString	m_variableScope

std::queue< char >	m_userInputQueue

enum PVXMLSession:: { ... }	m_recordingStatus

bool	m_recordStopOnDTMF

PString	m_recordingName

PTime	m_recordingStartTime

PDirectory	m_recordDirectory

enum PVXMLSession:: { ... }	m_transferStatus

PTime	m_transferStartTime

Protected Attributes inherited from PIndirectChannel
PChannel *	readChannel
	Channel for read operations. More...

PBoolean	readAutoDelete
	Automatically delete read channel on destruction. More...

PChannel *	writeChannel
	Channel for write operations. More...

PBoolean	writeAutoDelete
	Automatically delete write channel on destruction. More...

Protected Attributes inherited from PChannel
PTimeInterval	readTimeout
	Timeout for read operations. More...

PTimeInterval	writeTimeout
	Timeout for write operations. More...

atomic< P_INT_PTR >	os_handle
	The operating system file handle return by standard open() function. More...

PThreadLocalStorage< Status >	m_status [NumErrorGroups+1]

PXBlockType	px_lastBlockType

PThread *	px_readThread

PThread *	px_writeThread

PThread *	px_selectThread [3]

PCriticalSection	px_selectMutex [3]

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Member Enumeration Documentation

anonymous enum

protected

Enumerator
NotRecording
RecordingInProgress
RecordingComplete

anonymous enum

protected

Enumerator
NotTransfering
TransferInProgress
TransferFailed
TransferSuccessful
TransferCompleted

enum PVXMLSession::TransferType

Enumerator
BridgedTransfer
BlindTransfer
ConsultationTransfer

Constructor & Destructor Documentation

PVXMLSession::PVXMLSession	(	PTextToSpeech *	tts = `NULL`,
		PBoolean	autoDelete = `false`
	)

virtual PVXMLSession::~PVXMLSession ( )

virtual

Member Function Documentation

void PVXMLSession::ClearBargeIn ( )

protected

virtual PBoolean PVXMLSession::Close ( )

virtual

Close the channel.

This will detach itself from the read and write channels and delete both of them if they are auto delete.

Returns: true if the channel is closed.

Reimplemented from PIndirectChannel.

virtual PString PVXMLSession::EvaluateExpr ( const PString & oexpr )

virtual

bool PVXMLSession::ExecuteCondition ( PXMLElement & element )

protected

PXMLElement* PVXMLSession::FindElementWithCount	(	PXMLElement &	parent,
		const PString &	name,
		unsigned	count
	)

void PVXMLSession::FlushInput ( )

protected

PVXMLChannel* PVXMLSession::GetAndLockVXMLChannel ( )

virtual void PVXMLSession::GetBeepData	(	PBYTEArray &	data,
		unsigned	ms
	)

virtual

PVXMLCache& PVXMLSession::GetCache ( )

const PDirectory& PVXMLSession::GetRecordDirectory ( ) const

inline

References m_recordDirectory.

PMutex& PVXMLSession::GetSessionMutex ( )

inline

PTextToSpeech* PVXMLSession::GetTextToSpeech ( ) const

inline

References m_textToSpeech.

virtual PCaselessString PVXMLSession::GetVar ( const PString & str ) const

virtual

PStringToString PVXMLSession::GetVariables ( ) const

__inline PVXMLChannel* PVXMLSession::GetVXMLChannel ( ) const

inline

References PIndirectChannel::readChannel.

PString PVXMLSession::GetXMLError ( ) const

inline

References m_lastXMLError.

bool PVXMLSession::GoToEventHandler	(	PXMLElement &	element,
		const PString &	eventName
	)

virtual bool PVXMLSession::InternalLoadVXML	(	const PString &	xml,
		const PString &	firstForm
	)

protectedvirtual

virtual void PVXMLSession::InternalStartThread ( )

protectedvirtual

virtual void PVXMLSession::InternalStartVXML ( )

protectedvirtual

virtual void PVXMLSession::InternalThreadMain ( )

protectedvirtual

virtual PBoolean PVXMLSession::IsLoaded ( ) const

inlinevirtual

References m_currentXML.

virtual PBoolean PVXMLSession::Load ( const PString & source )

virtual

virtual PBoolean PVXMLSession::LoadFile	(	const PFilePath &	file,
		const PString &	firstForm = `PString::Empty()`
	)

virtual

virtual PBoolean PVXMLSession::LoadGrammar ( PVXMLGrammar * grammar )

virtual

virtual PBoolean PVXMLSession::LoadURL ( const PURL & url )

virtual

virtual PBoolean PVXMLSession::LoadVXML	(	const PString &	xml,
		const PString &	firstForm = `PString::Empty()`
	)

virtual

virtual bool PVXMLSession::NextNode ( bool processChildren )

protectedvirtual

PURL PVXMLSession::NormaliseResourceName ( const PString & src )

protected

virtual void PVXMLSession::OnEndDialog ( )

virtual

virtual void PVXMLSession::OnEndRecording	(	PINDEX	bytesRecorded,
		bool	timedOut
	)

virtual

virtual void PVXMLSession::OnEndSession ( )

virtual

virtual bool PVXMLSession::OnTransfer	(	const PString &	,
		TransferType
	)

inlinevirtual

virtual void PVXMLSession::OnUserInput ( const PString & str )

virtual

virtual bool PVXMLSession::Open	(	const PString &	mediaFormat,
		unsigned	sampleRate = `8000`,
		unsigned	channels = `1`
	)

virtual

PVXMLSession::PDECLARE_MUTEX ( m_sessionMutex )

protected

PVXMLSession::PDECLARE_MUTEX ( m_userInputMutex )

protected

virtual PBoolean PVXMLSession::PlayCommand	(	const PString &	data,
		PINDEX	repeat = `1`,
		PINDEX	delay = `0`
	)

virtual

virtual PBoolean PVXMLSession::PlayData	(	const PBYTEArray &	data,
		PINDEX	repeat = `1`,
		PINDEX	delay = `0`
	)

virtual

virtual PBoolean PVXMLSession::PlayElement ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::PlayFile	(	const PString &	fn,
		PINDEX	repeat = `1`,
		PINDEX	delay = `0`,
		PBoolean	autoDelete = `false`
	)

virtual

virtual PBoolean PVXMLSession::PlayResource	(	const PURL &	url,
		PINDEX	repeat = `1`,
		PINDEX	delay = `0`
	)

virtual

virtual PBoolean PVXMLSession::PlaySilence ( PINDEX msecs = 0 )

virtual

virtual PBoolean PVXMLSession::PlaySilence ( const PTimeInterval & timeout )

virtual

virtual PBoolean PVXMLSession::PlayStop ( )

virtual

virtual PBoolean PVXMLSession::PlayText	(	const PString &	text,
		PTextToSpeech::TextType	type = `PTextToSpeech::Default`,
		PINDEX	repeat = `1`,
		PINDEX	delay = `0`
	)

virtual

virtual PBoolean PVXMLSession::PlayTone	(	const PString &	toneSpec,
		PINDEX	repeat = `1`,
		PINDEX	delay = `0`
	)

virtual

virtual bool PVXMLSession::ProcessEvents ( )

protectedvirtual

virtual bool PVXMLSession::ProcessNode ( )

protectedvirtual

void PVXMLSession::SayAs	(	const PString &	className,
		const PString &	text
	)

protected

void PVXMLSession::SayAs	(	const PString &	className,
		const PString &	text,
		const PString &	voice
	)

protected

void PVXMLSession::SetCache ( PVXMLCache & cache )

bool PVXMLSession::SetCurrentForm	(	const PString &	id,
		bool	fullURI
	)

virtual void PVXMLSession::SetPause ( PBoolean pause )

virtual

void PVXMLSession::SetRecordDirectory ( const PDirectory & dir )

inline

References m_recordDirectory.

PTextToSpeech* PVXMLSession::SetTextToSpeech	(	PTextToSpeech *	tts,
		PBoolean	autoDelete = `false`
	)

PTextToSpeech* PVXMLSession::SetTextToSpeech ( const PString & ttsName )

void PVXMLSession::SetTransferComplete ( bool state )

virtual void PVXMLSession::SetVar	(	const PString &	ostr,
		const PString &	val
	)

virtual

static PTimeInterval PVXMLSession::StringToTime	(	const PString &	str,
		int	dflt = `0`
	)

static

virtual PBoolean PVXMLSession::TraverseAudio ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseBlock ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseBreak ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseChoice ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraversedField ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraversedForm ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraversedIf ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseDisconnect ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraversedMenu ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraversedPrompt ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraversedRecord ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraversedTransfer ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseElse ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseElseIf ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseExit ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseField ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseForm ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseGoto ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseGrammar ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseIf ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseMenu ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraversePrompt ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseProperty ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseRecord ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseSayAs ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseScript ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseSubmit ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseTransfer ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseValue ( PXMLElement & element )

virtual

virtual PBoolean PVXMLSession::TraverseVar ( PXMLElement & element )

virtual

virtual void PVXMLSession::Trigger ( )

virtual

void PVXMLSession::UnLockVXMLChannel ( )

inline

Member Data Documentation

bool PVXMLSession::m_abortVXML

protected

bool PVXMLSession::m_autoDeleteTextToSpeech

protected

bool PVXMLSession::m_bargeIn

protected

bool PVXMLSession::m_bargingIn

protected

PXMLObject* PVXMLSession::m_currentNode

protected

PAutoPtr<PXML> PVXMLSession::m_currentXML

protected

Referenced by IsLoaded().

char PVXMLSession::m_defaultMenuDTMF

protected

std::map<std::string, unsigned> PVXMLSession::m_eventCount

protected

PVXMLGrammar* PVXMLSession::m_grammar

protected

PString PVXMLSession::m_lastXMLError

protected

Referenced by GetXMLError().

PString PVXMLSession::m_newFormName

protected

PAutoPtr<PXML> PVXMLSession::m_newXML

protected

unsigned PVXMLSession::m_promptCount

protected

PDirectory PVXMLSession::m_recordDirectory

protected

Referenced by GetRecordDirectory(), and SetRecordDirectory().

PString PVXMLSession::m_recordingName

protected

PTime PVXMLSession::m_recordingStartTime

protected

enum { ... } PVXMLSession::m_recordingStatus

bool PVXMLSession::m_recordStopOnDTMF

protected

PURL PVXMLSession::m_rootURL

protected

bool PVXMLSession::m_speakNodeData

protected

PTextToSpeech* PVXMLSession::m_textToSpeech

protected

Referenced by GetTextToSpeech().

PTime PVXMLSession::m_transferStartTime

protected

enum { ... } PVXMLSession::m_transferStatus

PVXMLCache* PVXMLSession::m_ttsCache

protected

std::queue<char> PVXMLSession::m_userInputQueue

protected

PStringToString PVXMLSession::m_variables

protected

PString PVXMLSession::m_variableScope

protected

PThread* PVXMLSession::m_vxmlThread

protected

PSyncPoint PVXMLSession::m_waitForEvent

protected

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

vxml.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation