<!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: Switch2FaxG3 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>Switch2FaxG3 Class Reference</h1>Call Module for switching to FAXG3 service from another one. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="switch2faxG3_8h-source.html">switch2faxG3.h</a>></code> <p> <p>Inheritance diagram for Switch2FaxG3: <p><center><img src="classSwitch2FaxG3.png" usemap="#Switch2FaxG3_map" border="0" alt=""></center> <map name="Switch2FaxG3_map"> <area href="classCallModule.html" alt="CallModule" shape="rect" coords="0,56,93,80"> <area href="classCallInterface.html" alt="CallInterface" shape="rect" coords="0,0,93,24"> </map> <a href="classSwitch2FaxG3-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="classSwitch2FaxG3.html#a0">Switch2FaxG3</a> (<a class="el" href="classConnection.html">Connection</a> *<a class="el" href="classCallModule.html#p3">conn</a>, string <a class="el" href="classSwitch2FaxG3.html#r0">faxStationID</a>, string <a class="el" href="classSwitch2FaxG3.html#r1">faxHeadline</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. Create object. <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="classSwitch2FaxG3.html#a1">mainLoop</a> () throw (CapiWrongState, CapiExternalError, CapiMsgError)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Do all needed steps (disconnect logical, wait, switch to fax, wait). <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="classSwitch2FaxG3.html#a2">callDisconnectedLogical</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Finish first wait if the logical disconnection succeeded. <a href="#a2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classSwitch2FaxG3.html#a3">callConnected</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Finish second wait if logical connection has been re-established. <a href="#a3"></a><br></td></tr> <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>string </td><td class="memItemRight" valign=bottom><a class="el" href="classSwitch2FaxG3.html#r0">faxStationID</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">fax station ID to use <a href="#r0"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>string </td><td class="memItemRight" valign=bottom><a class="el" href="classSwitch2FaxG3.html#r1">faxHeadline</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">fax headline to use <a href="#r1"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Call Module for switching to FAXG3 service from another one. <p> This module does all the necessary steps to switch from another service (mostly VOICE) to FaxG3 service (see <a class="el" href="classConnection.html#w10">Connection::service_t</a>). The steps are:<p> <ul> <li>disconnect logical connection</li><li>wait for completion of disconnect</li><li>call <a class="el" href="classConnection.html#a3">Connection::changeProtocol()</a> to switch to faxG3</li><li>wait for logical connection to re-establish </li></ul> <p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="a0" doxytag="Switch2FaxG3::Switch2FaxG3" ></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"> Switch2FaxG3::Switch2FaxG3 </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>string </td> <td class="mdname" nowrap> <em>faxStationID</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap>string </td> <td class="mdname" nowrap> <em>faxHeadline</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. <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>faxStationID</em> </td><td>fax station ID to use </td></tr> <tr><td></td><td valign=top><em>faxHeadline</em> </td><td>fax headline to use</td></tr> </table> </dl> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="a3" doxytag="Switch2FaxG3::callConnected" ></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 Switch2FaxG3::callConnected </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 second wait if logical connection has been re-established. <p> <p> Reimplemented from <a class="el" href="classCallModule.html#a5">CallModule</a>. <p> </td> </tr> </table> <a class="anchor" name="a2" doxytag="Switch2FaxG3::callDisconnectedLogical" ></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 Switch2FaxG3::callDisconnectedLogical </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 first wait if the logical disconnection succeeded. <p> <p> Reimplemented from <a class="el" href="classCallModule.html#a6">CallModule</a>. <p> </td> </tr> </table> <a class="anchor" name="a1" doxytag="Switch2FaxG3::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 Switch2FaxG3::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>, <a class="el" href="classCapiExternalError.html">CapiExternalError</a>, <a class="el" href="classCapiMsgError.html">CapiMsgError</a>)<code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Do all needed steps (disconnect logical, wait, switch to fax, wait). <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 by <a class="el" href="classCallModule.html#a2">CallModule::mainLoop</a>, <a class="el" href="classConnection.html#a3">Connection::changeProtocol</a> </td></tr> <tr><td></td><td valign=top><em>CapiExternalError</em> </td><td>Thrown by <a class="el" href="classConnection.html#a3">Connection::changeProtocol</a> </td></tr> <tr><td></td><td valign=top><em>CapiMsgError</em> </td><td>Thrown by <a class="el" href="classConnection.html#a3">Connection::changeProtocol</a>, <a class="el" href="classConnection.html#a8">Connection::disconnectCall</a></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="r1" doxytag="Switch2FaxG3::faxHeadline" ></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"> string <a class="el" href="classSwitch2FaxG3.html#r1">Switch2FaxG3::faxHeadline</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> fax headline to use <p> </td> </tr> </table> <a class="anchor" name="r0" doxytag="Switch2FaxG3::faxStationID" ></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"> string <a class="el" href="classSwitch2FaxG3.html#r0">Switch2FaxG3::faxStationID</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> fax station ID to use <p> </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="switch2faxG3_8h-source.html">switch2faxG3.h</a><li>switch2faxG3.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>