#include <vxml.h>

Inheritance diagram for PVXMLChannel:

Collaboration diagram for PVXMLChannel:

Public Member Functions
	~PVXMLChannel ()

virtual bool	Open (PVXMLSession *session, unsigned sampleRate, unsigned channels)

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

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

virtual PBoolean	Read (void *buffer, PINDEX amount)
	Low level read from the file channel. More...

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

virtual PString	GetAudioFormat () const =0

bool	IsMediaPCM () const

virtual unsigned	GetSampleRate () const =0

virtual bool	SetSampleRate (unsigned rate)=0

virtual unsigned	GetChannels () const =0

virtual bool	SetChannels (unsigned channels)=0

virtual PString	GetMediaFileSuffix () const

virtual bool	AdjustMediaFilename (const PFilePath &ifn, PFilePath &ofn)

virtual PChannel *	OpenMediaFile (const PFilePath &fn, bool recording)

virtual PBoolean	WriteFrame (const void *buf, PINDEX len)=0

virtual PBoolean	IsSilenceFrame (const void *buf, PINDEX len) const =0

virtual bool	QueueRecordable (PVXMLRecordable *newItem)

bool	EndRecording (bool timedOut)

bool	IsRecording () const

virtual PBoolean	ReadFrame (void *buffer, PINDEX amount)=0

virtual PINDEX	CreateSilenceFrame (void *buffer, PINDEX amount)=0

virtual void	GetBeepData (PBYTEArray &, unsigned)

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

virtual PBoolean	QueuePlayable (const PString &type, const PString &str, PINDEX repeat=1, PINDEX delay=0, PBoolean autoDelete=false)

virtual PBoolean	QueuePlayable (PVXMLPlayable *newItem)

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

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

virtual PBoolean	QueueCommand (const PString &cmd, PINDEX repeat=1, PINDEX delay=0)

virtual void	FlushQueue ()

virtual PBoolean	IsPlaying () const

void	SetPause (PBoolean pause)

void	SetSilence (unsigned msecs)

Public Member Functions inherited from PDelayChannel
	PDelayChannel (Mode mode, unsigned frameDelay, PINDEX frameSize=0, unsigned maximumSlip=250, unsigned minimumDelay=10)
	Create a new delay channel with the specified delays. More...

	PDelayChannel (PChannel &channel, Mode mode, unsigned frameDelay, PINDEX frameSize=0, unsigned maximumSlip=250, unsigned minimumDelay=10)
	Create a new delay channel with the specified delays and channel. More...

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 int	ReadChar ()
	Read a single character from 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...

Protected Member Functions
	PVXMLChannel (unsigned frameDelay, PINDEX frameSize)

	PDECLARE_MUTEX (m_recordingMutex)

	PDECLARE_MUTEX (m_playQueueMutex)

Protected Member Functions inherited from PDelayChannel
virtual void	Wait (PINDEX count, PTimeInterval &nextTick)

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
PVXMLSession *	m_vxmlSession

bool	m_closed

bool	m_paused

PINDEX	m_totalData

PVXMLRecordable *	m_recordable

PVXMLQueue	m_playQueue

PVXMLPlayable *	m_currentPlayItem

PSimpleTimer	m_silenceTimer

Protected Attributes inherited from PDelayChannel
Mode	mode

unsigned	frameDelay

PINDEX	frameSize

PTimeInterval	maximumSlip

PTimeInterval	minimumDelay

PTimeInterval	nextReadTick

PTimeInterval	nextWriteTick

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

Additional Inherited Members
Public Types inherited from PDelayChannel
enum	Mode { DelayReadsOnly, DelayWritesOnly, DelayReadsAndWrites }

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

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

Constructor & Destructor Documentation

PVXMLChannel::PVXMLChannel	(	unsigned	frameDelay,
		PINDEX	frameSize
	)

protected

PVXMLChannel::~PVXMLChannel ( )

Member Function Documentation

virtual bool PVXMLChannel::AdjustMediaFilename	(	const PFilePath &	ifn,
		PFilePath &	ofn
	)

virtual

virtual PBoolean PVXMLChannel::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 PINDEX PVXMLChannel::CreateSilenceFrame	(	void *	buffer,
		PINDEX	amount
	)

pure virtual

bool PVXMLChannel::EndRecording ( bool timedOut )

virtual void PVXMLChannel::FlushQueue ( )

virtual

virtual PString PVXMLChannel::GetAudioFormat ( ) const

pure virtual

Referenced by IsMediaPCM().

virtual void PVXMLChannel::GetBeepData	(	PBYTEArray &	,
		unsigned
	)

inlinevirtual

virtual unsigned PVXMLChannel::GetChannels ( ) const

pure virtual

virtual PString PVXMLChannel::GetMediaFileSuffix ( ) const

virtual

virtual unsigned PVXMLChannel::GetSampleRate ( ) const

pure virtual

bool PVXMLChannel::IsMediaPCM ( ) const

inline

References GetAudioFormat(), and VXML_PCM16.

virtual PBoolean PVXMLChannel::IsOpen ( ) const

virtual

Determine if the channel is currently open and read and write operations can be executed on it.

For example, in the PFile class it returns if the file is currently open.

Returns: true if the channel is open.

Reimplemented from PIndirectChannel.

virtual PBoolean PVXMLChannel::IsPlaying ( ) const

inlinevirtual

References m_currentPlayItem, and m_playQueue.

bool PVXMLChannel::IsRecording ( ) const

inline

References m_recordable.

virtual PBoolean PVXMLChannel::IsSilenceFrame	(	const void *	buf,
		PINDEX	len
	)		const

pure virtual

virtual bool PVXMLChannel::Open	(	PVXMLSession *	session,
		unsigned	sampleRate,
		unsigned	channels
	)

virtual

virtual PChannel* PVXMLChannel::OpenMediaFile	(	const PFilePath &	fn,
		bool	recording
	)

virtual

PVXMLChannel::PDECLARE_MUTEX ( m_recordingMutex )

protected

PVXMLChannel::PDECLARE_MUTEX ( m_playQueueMutex )

protected

virtual PBoolean PVXMLChannel::QueueCommand	(	const PString &	cmd,
		PINDEX	repeat = `1`,
		PINDEX	delay = `0`
	)

inlinevirtual

References QueuePlayable().

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

virtual

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

inlinevirtual

References QueuePlayable().

virtual PBoolean PVXMLChannel::QueuePlayable	(	const PString &	type,
		const PString &	str,
		PINDEX	repeat = `1`,
		PINDEX	delay = `0`,
		PBoolean	autoDelete = `false`
	)

virtual

Referenced by QueueCommand(), and QueueFile().

virtual PBoolean PVXMLChannel::QueuePlayable ( PVXMLPlayable * newItem )

virtual

virtual bool PVXMLChannel::QueueRecordable ( PVXMLRecordable * newItem )

virtual

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

virtual

virtual PBoolean PVXMLChannel::Read	(	void *	buf,
		PINDEX	len
	)

virtual

Low level read from the file channel.

The read timeout is ignored for file I/O. The GetLastReadCount() function returns the actual number of bytes read.

The GetErrorCode() function should be consulted after Read() returns false to determine what caused the failure.

Returns: true indicates that at least one character was read from the channel. false means no bytes were read due to timeout or some other I/O error.

Reimplemented from PDelayChannel.

virtual PBoolean PVXMLChannel::ReadFrame	(	void *	buffer,
		PINDEX	amount
	)

pure virtual

virtual bool PVXMLChannel::SetChannels ( unsigned channels )

pure virtual

void PVXMLChannel::SetPause ( PBoolean pause )

inline

References m_paused.

virtual bool PVXMLChannel::SetSampleRate ( unsigned rate )

pure virtual

void PVXMLChannel::SetSilence ( unsigned msecs )

virtual PBoolean PVXMLChannel::Write	(	const void *	buf,
		PINDEX	len
	)

virtual

Low level write to the file channel.

The write timeout is ignored for file I/O. The GetLastWriteCount() function returns the actual number of bytes written.

The GetErrorCode() function should be consulted after Write() returns false to determine what caused the failure.

Returns: true if at least len bytes were written to the channel.

Reimplemented from PDelayChannel.

virtual PBoolean PVXMLChannel::WriteFrame	(	const void *	buf,
		PINDEX	len
	)

pure virtual

Member Data Documentation

bool PVXMLChannel::m_closed

protected

PVXMLPlayable* PVXMLChannel::m_currentPlayItem

protected

Referenced by IsPlaying().

bool PVXMLChannel::m_paused

protected

Referenced by SetPause().

PVXMLQueue PVXMLChannel::m_playQueue

protected

Referenced by IsPlaying().

PVXMLRecordable* PVXMLChannel::m_recordable

protected

Referenced by IsRecording().

PSimpleTimer PVXMLChannel::m_silenceTimer

protected

PINDEX PVXMLChannel::m_totalData

protected

PVXMLSession* PVXMLChannel::m_vxmlSession

protected

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

vxml.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation