PTLib  Version 2.10.11
PVXMLChannel Class Referenceabstract

#include <vxml.h>

Inheritance diagram for PVXMLChannel:
PDelayChannel PIndirectChannel PChannel PObject

Public Member Functions

 PVXMLChannel (unsigned frameDelay, PINDEX frameSize)
 
 ~PVXMLChannel ()
 
virtual PBoolean Open (PVXMLSession *session)
 
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 PWAVFileCreateWAVFile (const PFilePath &fn, PBoolean recording=false)
 
const PStringGetMediaFormat () const
 
PBoolean IsMediaPCM () const
 
virtual PString AdjustWavFilename (const PString &fn)
 
virtual PBoolean WriteFrame (const void *buf, PINDEX len)=0
 
virtual PBoolean IsSilenceFrame (const void *buf, PINDEX len) const =0
 
virtual PBoolean QueueRecordable (PVXMLRecordable *newItem)
 
PBoolean StartRecording (const PFilePath &fn, unsigned finalSilence=3000, unsigned maxDuration=30000)
 
PBoolean EndRecording ()
 
PBoolean 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)
 
unsigned GetSampleFrequency () const
 
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 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 PChannelGetBaseReadChannel () const
 This function returns the eventual base channel for reading of a series of indirect channels provided by descendents of PIndirectChannel. More...
 
virtual PChannelGetBaseWriteChannel () const
 This function returns the eventual base channel for writing of a series of indirect channels provided by descendents of 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...
 
PChannelGetReadChannel () 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...
 
PChannelGetWriteChannel () 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...
 
- Public Member Functions inherited from PChannel
PBoolean SetErrorValues (Errors errorCode, int osError, ErrorGroup group=LastGeneralError)
 Set error values to those specified. More...
 
 PChannel ()
 Create the channel. More...
 
 ~PChannel ()
 Close down the channel. More...
 
virtual PINDEX HashFunction () const
 Calculate a hash value for use in sets and dictionaries. More...
 
int GetHandle () const
 Get the integer operating system handle for the channel. 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 int ReadChar ()
 Read a single 8 bit byte from the channel. More...
 
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...
 
virtual PBoolean ReadAsync (void *buf, PINDEX len)
 Begin an asynchronous read from channel. More...
 
virtual void OnReadComplete (void *buf, PINDEX len)
 User callback function for when a ReadAsync() call has completed or timed out. 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 *mark)
 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...
 
PBoolean WriteChar (int c)
 Write a single character to the channel. More...
 
PBoolean WriteString (const PString &str)
 Write a string to the channel. More...
 
virtual PBoolean WriteAsync (const void *buf, PINDEX len)
 Begin an asynchronous write from channel. More...
 
virtual void OnWriteComplete (const void *buf, PINDEX len)
 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...
 
Errors GetErrorCode (ErrorGroup group=NumErrorGroups) const
 Get normalised error code. More...
 
int GetErrorNumber (ErrorGroup group=NumErrorGroups) const
 Get OS errro code. More...
 
virtual PBoolean Read (const VectorOfSlice &slices)
 Low level scattered read from the channel. More...
 
virtual PBoolean Write (const VectorOfSlice &slices)
 Low level scattered write to the channel. More...
 
- Public Member Functions inherited from PObject
virtual ~PObject ()
 
virtual PObjectClone () const
 Create a copy of the class on the heap. More...
 
virtual const char * GetClass (unsigned ancestor=0) const
 Get the current dynamic type of the object instance. More...
 
PBoolean IsClass (const char *cls) const
 
virtual PBoolean InternalIsDescendant (const char *clsName) const
 Determine if the dynamic type of the current instance is a descendent of the specified class. 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 Attributes

PVXMLSessionm_vxmlSession
 
unsigned m_sampleFrequency
 
PString mediaFormat
 
PString wavFilePrefix
 
PMutex m_channelWriteMutex
 
PMutex m_channelReadMutex
 
bool m_closed
 
bool m_paused
 
PINDEX m_totalData
 
PVXMLRecordablem_recordable
 
unsigned m_finalSilence
 
unsigned m_silenceRun
 
PVXMLQueue m_playQueue
 
PVXMLPlayablem_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
PChannelreadChannel
 Channel for read operations. More...
 
PBoolean readAutoDelete
 Automatically delete read channel on destruction. More...
 
PChannelwriteChannel
 Channel for write operations. More...
 
PBoolean writeAutoDelete
 Automatically delete write channel on destruction. More...
 
PReadWriteMutex channelPointerMutex
 Race condition prevention on closing channel. More...
 
- Protected Attributes inherited from PChannel
int os_handle
 The operating system file handle return by standard open() function. More...
 
Errors lastErrorCode [NumErrorGroups+1]
 The platform independant error code. More...
 
int lastErrorNumber [NumErrorGroups+1]
 The operating system error number (eg as returned by errno). More...
 
PINDEX lastReadCount
 Number of byte last read by the Read() function. More...
 
PINDEX lastWriteCount
 Number of byte last written by the Write() function. More...
 
PTimeInterval readTimeout
 Timeout for read operations. More...
 
PTimeInterval writeTimeout
 Timeout for write operations. More...
 
PString channelName
 
PMutex px_threadMutex
 
PXBlockType px_lastBlockType
 
PThreadpx_readThread
 
PThreadpx_writeThread
 
PMutex px_writeMutex
 
PThreadpx_selectThread [3]
 
PMutex px_selectMutex [3]
 

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  ShutdownValue { ShutdownRead = 0, ShutdownWrite = 1, ShutdownReadAndWrite = 2 }
 
enum  Errors {
  NoError, NotFound, FileExists, DiskFull,
  AccessDenied, DeviceInUse, BadParameter, NoMemory,
  NotOpen, Timeout, Interrupted, BufferTooSmall,
  Miscellaneous, ProtocolFailure, NumNormalisedErrors
}
 Normalised error codes. More...
 
enum  ErrorGroup { LastReadError, LastWriteError, LastGeneralError, NumErrorGroups }
 Error groups. More...
 
typedef std::vector< SliceVectorOfSlice
 
- 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 PBoolean ConvertOSError (int libcReturnValue, Errors &lastError, int &osError)
 Convert an operating system error into platform independent error. More...
 
static PString GetErrorText (Errors lastError, int osError=0)
 Get error message description. More...
 
- Static Public Member Functions inherited from PObject
static const char * Class ()
 Get the name of the class as a C string. More...
 
static Comparison InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
 Internal function caled from CompareObjectMemoryDirect() More...
 
- 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...
 
- Protected Member Functions inherited from PChannel
 PChannel (const PChannel &)
 
PChanneloperator= (const PChannel &)
 
virtual PBoolean ConvertOSError (int 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)
 
PBoolean PXSetIOBlock (PXBlockType type, const PTimeInterval &timeout)
 
int PXClose ()
 
- Protected Member Functions inherited from PObject
 PObject ()
 Constructor for PObject, made protected so cannot ever create one on its own. More...
 

Constructor & Destructor Documentation

§ PVXMLChannel()

PVXMLChannel::PVXMLChannel ( unsigned  frameDelay,
PINDEX  frameSize 
)

§ ~PVXMLChannel()

PVXMLChannel::~PVXMLChannel ( )

Member Function Documentation

§ AdjustWavFilename()

virtual PString PVXMLChannel::AdjustWavFilename ( const PString fn)
virtual

§ Close()

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.

§ CreateSilenceFrame()

virtual PINDEX PVXMLChannel::CreateSilenceFrame ( void *  buffer,
PINDEX  amount 
)
pure virtual

§ CreateWAVFile()

virtual PWAVFile* PVXMLChannel::CreateWAVFile ( const PFilePath fn,
PBoolean  recording = false 
)
virtual

§ EndRecording()

PBoolean PVXMLChannel::EndRecording ( )

§ FlushQueue()

virtual void PVXMLChannel::FlushQueue ( )
virtual

§ GetBeepData()

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

§ GetMediaFormat()

const PString& PVXMLChannel::GetMediaFormat ( ) const
inline

§ GetSampleFrequency()

unsigned PVXMLChannel::GetSampleFrequency ( ) const
inline

§ IsMediaPCM()

PBoolean PVXMLChannel::IsMediaPCM ( ) const
inline

§ IsOpen()

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.

§ IsPlaying()

virtual PBoolean PVXMLChannel::IsPlaying ( ) const
inlinevirtual

§ IsRecording()

PBoolean PVXMLChannel::IsRecording ( ) const
inline

§ IsSilenceFrame()

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

§ Open()

virtual PBoolean PVXMLChannel::Open ( PVXMLSession session)
virtual

§ QueueCommand()

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

§ QueueData()

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

§ QueueFile()

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

§ QueuePlayable() [1/2]

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

§ QueuePlayable() [2/2]

virtual PBoolean PVXMLChannel::QueuePlayable ( PVXMLPlayable newItem)
virtual

§ QueueRecordable()

virtual PBoolean PVXMLChannel::QueueRecordable ( PVXMLRecordable newItem)
virtual

§ QueueResource()

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

§ Read()

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.

§ ReadFrame()

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

§ SetPause()

void PVXMLChannel::SetPause ( PBoolean  pause)
inline

§ SetSilence()

void PVXMLChannel::SetSilence ( unsigned  msecs)

§ StartRecording()

PBoolean PVXMLChannel::StartRecording ( const PFilePath fn,
unsigned  finalSilence = 3000,
unsigned  maxDuration = 30000 
)

§ Write()

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.

§ WriteFrame()

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

Member Data Documentation

§ m_channelReadMutex

PMutex PVXMLChannel::m_channelReadMutex
protected

§ m_channelWriteMutex

PMutex PVXMLChannel::m_channelWriteMutex
protected

§ m_closed

bool PVXMLChannel::m_closed
protected

§ m_currentPlayItem

PVXMLPlayable* PVXMLChannel::m_currentPlayItem
protected

§ m_finalSilence

unsigned PVXMLChannel::m_finalSilence
protected

§ m_paused

bool PVXMLChannel::m_paused
protected

§ m_playQueue

PVXMLQueue PVXMLChannel::m_playQueue
protected

§ m_recordable

PVXMLRecordable* PVXMLChannel::m_recordable
protected

§ m_sampleFrequency

unsigned PVXMLChannel::m_sampleFrequency
protected

§ m_silenceRun

unsigned PVXMLChannel::m_silenceRun
protected

§ m_silenceTimer

PSimpleTimer PVXMLChannel::m_silenceTimer
protected

§ m_totalData

PINDEX PVXMLChannel::m_totalData
protected

§ m_vxmlSession

PVXMLSession* PVXMLChannel::m_vxmlSession
protected

§ mediaFormat

PString PVXMLChannel::mediaFormat
protected

§ wavFilePrefix

PString PVXMLChannel::wavFilePrefix
protected

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