<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CapiSuite: ReadDTMF Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.8 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>ReadDTMF Class Reference</h1>Call Module for waiting for DTMF signals.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="readDTMF_8h-source.html">readDTMF.h</a>></code>
<p>
<p>Inheritance diagram for ReadDTMF:
<p><center><img src="classReadDTMF.png" usemap="#ReadDTMF_map" border="0" alt=""></center>
<map name="ReadDTMF_map">
<area href="classCallModule.html" alt="CallModule" shape="rect" coords="0,56,84,80">
<area href="classCallInterface.html" alt="CallInterface" shape="rect" coords="0,0,84,24">
</map>
<a href="classReadDTMF-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classReadDTMF.html#a0">ReadDTMF</a> (<a class="el" href="classConnection.html">Connection</a> *<a class="el" href="classCallModule.html#p3">conn</a>, int <a class="el" href="classCallModule.html#p5">timeout</a>, int <a class="el" href="classReadDTMF.html#r1">min_digits</a>, int <a class="el" href="classReadDTMF.html#r2">max_digits</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. Create Object and read the current digit count from <a class="el" href="classConnection.html">Connection</a>. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classReadDTMF.html#a1">mainLoop</a> () throw (CapiWrongState)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">mainLoop: Waits until the given conditions (see constructor) have been fulfilled <a href="#a1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classReadDTMF.html#a2">gotDTMF</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">finish if max_digits is reached, otherwise restart timeout when DTMF signal is received <a href="#a2"></a><br></td></tr>
<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classReadDTMF.html#r0">digit_count</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">save the current number of digits in receive buffer <a href="#r0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classReadDTMF.html#r1">min_digits</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">save min_digits parameter <a href="#r1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classReadDTMF.html#r2">max_digits</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">save max_digits parameter <a href="#r2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Call Module for waiting for DTMF signals.
<p>
This module allows the user to specify how much DTMF digits he wants to read and how long to wait for them. It doesn't do the actual read, just waits for the given conditions to be fulfilled.<p>
To use it, create an object and call <a class="el" href="classReadDTMF.html#a1">mainLoop()</a>. After <a class="el" href="classReadDTMF.html#a1">mainLoop()</a> finished, call <a class="el" href="classConnection.html#a14">Connection::getDTMF()</a> to read the received signals.<p>
<dl compact><dt><b>Author:</b></dt><dd>Gernot Hillier </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="ReadDTMF::ReadDTMF" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ReadDTMF::ReadDTMF </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classConnection.html">Connection</a> * </td>
<td class="mdname" nowrap> <em>conn</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>timeout</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>min_digits</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>max_digits</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor. Create Object and read the current digit count from <a class="el" href="classConnection.html">Connection</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>conn</em> </td><td>reference to <a class="el" href="classConnection.html">Connection</a> object </td></tr>
<tr><td></td><td valign=top><em>timeout</em> </td><td>timeout in seconds after which reading is terminated (only terminates when min_digits are reached!), restarts after each digit </td></tr>
<tr><td></td><td valign=top><em>min_digits</em> </td><td>minimum number of digits which must be read in ANY case without respect to timout. Only set to value >0 if you're sure the user will input a digit. </td></tr>
<tr><td></td><td valign=top><em>max_digits</em> </td><td>maximum number of digits to read, we abort immediately if this number is reached (0=infinite, only timeout counts)</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a2" doxytag="ReadDTMF::gotDTMF" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ReadDTMF::gotDTMF </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
finish if max_digits is reached, otherwise restart timeout when DTMF signal is received
<p>
<p>
Reimplemented from <a class="el" href="classCallModule.html#a8">CallModule</a>.
<p>
</td>
</tr>
</table>
<a class="anchor" name="a1" doxytag="ReadDTMF::mainLoop" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ReadDTMF::mainLoop </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> throw (<a class="el" href="classCapiWrongState.html">CapiWrongState</a>)<code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
mainLoop: Waits until the given conditions (see constructor) have been fulfilled
<p>
The module will finish if one of these conditions are true:<p>
<ul>
<li>max_digits is fulfilled</li><li>timeout was reached AND min_digits is fulfilled</li></ul>
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>CapiWrongState</em> </td><td>Thrown if disconnection is recognized</td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classCallModule.html#a2">CallModule</a>.
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="r0" doxytag="ReadDTMF::digit_count" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="classReadDTMF.html#r0">ReadDTMF::digit_count</a><code> [private]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
save the current number of digits in receive buffer
<p>
</td>
</tr>
</table>
<a class="anchor" name="r2" doxytag="ReadDTMF::max_digits" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="classReadDTMF.html#r2">ReadDTMF::max_digits</a><code> [private]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
save max_digits parameter
<p>
</td>
</tr>
</table>
<a class="anchor" name="r1" doxytag="ReadDTMF::min_digits" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="classReadDTMF.html#r1">ReadDTMF::min_digits</a><code> [private]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
save min_digits parameter
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="readDTMF_8h-source.html">readDTMF.h</a><li>readDTMF.cpp</ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 28 14:37:45 2004 for CapiSuite by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
06e1e0ab98898582c876a8be34ecb5e9
>
files
>
252
