AbstractProtocolHandler Class Reference

The abstract class to receive callback with parsed data. More...

Inheritance diagram for AbstractProtocolHandler:

ProtocolHandler

List of all members.

Public Member Functions

virtual void onFamily (Client &client, const std::string lang, const std::string &family)=0
 Notifies the command to select new voice family was received from client.
virtual void onLetter (Client &client, wchar_t c)=0
 Notifies the command to say one letter was received from client.
virtual void onParam (Client &client, int paramType, TextParam value)=0
 Notifies there was a command to set new value of speech parameter.
virtual void onProcMode (Client &client, const std::string &procMode)=0
 Notifies the command to select another processing mode was received.
virtual void onStop (Client &client)=0
 Notifies new command to stop playback was received from client.
virtual void onText (Client &client, const std::wstring &t)=0
 Notifies the command to say text was received from client.
virtual void onTone (Client &client, size_t freq, size_t duration)=0
 Notifies the new command to produce tone signal was received from client.


Detailed Description

This abstract class declares interface to receive events with data transmitted by a client. Every object for handling connection data must implement this interface. The reference to it is provided into protocol implementation class.

Member Function Documentation

virtual void AbstractProtocolHandler::onFamily ( Client client,
const std::string  lang,
const std::string &  family 
) [pure virtual]

The protocol implementation class cals this method each time when the command to select new voice family was received from client. The client object this command was received from, the language name to select family for and new voice family name are provided. The language string can be empty and it means new family must be selected for all languages in which it is registered.

Parameters:
[in] client The client this command was received from
[in] lang The language name to select family for, can be empty
[in] family The voice family to select

Implemented in ProtocolHandler.

virtual void AbstractProtocolHandler::onLetter ( Client client,
wchar_t  c 
) [pure virtual]

The protocol implementation calls this method each time when it receives command to say one letter. The client object this command was received from is provided.

Parameters:
[in] client The client object this command was received from
[in] c The character to say

Implemented in ProtocolHandler.

virtual void AbstractProtocolHandler::onParam ( Client client,
int  paramType,
TextParam  value 
) [pure virtual]

This method is called by protocol implementation object on every new command to change speech attribute value. Speech attribute can be one of three types: pitch, rate and volume.

Parameters:
[in] client The client object this command was received from
[in] paramType The attribute type to change, can be ParamPitch, ParamRate and ParamVolume
[in] value The new value to set

Implemented in ProtocolHandler.

virtual void AbstractProtocolHandler::onProcMode ( Client client,
const std::string &  procMode 
) [pure virtual]

This method is called by protocol implementation class on each command to select new text processing mode. The client object new command was received from and new mode name are provided.

Parameters:
[in] client The client this command was received from
[in] procMode The name of new text processing mode

Implemented in ProtocolHandler.

virtual void AbstractProtocolHandler::onStop ( Client client  )  [pure virtual]

The protocol implementation calls this function when it receives the command to stop any playback. The client object new command was received from is provided.

Parameters:
[in] client The client object this command was received from

Implemented in ProtocolHandler.

virtual void AbstractProtocolHandler::onText ( Client client,
const std::wstring &  t 
) [pure virtual]

The protocol implementation class calls this method on every command to say part of text and provides the client object this command was transmitted from.

Parameters:
[in] client The client object the command was received from
[in] t The text to say

Implemented in ProtocolHandler.

virtual void AbstractProtocolHandler::onTone ( Client client,
size_t  freq,
size_t  duration 
) [pure virtual]

This method is called by protocol implementation object each time when new command to produce tone signal is received from a client. The client object this command was received from is provided.

Parameters:
[in] client The client object this command was received from
[in] freq The frequency of tone signal to produce
[in] duration The new signal duration

Implemented in ProtocolHandler.


Generated on Thu May 6 16:10:58 2010 for VoiceMan by  doxygen 1.5.9