<!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: CallOutgoing 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>CallOutgoing Class Reference</h1>Call Module for establishment of an outgoing connection and wait for successful connect. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="calloutgoing_8h-source.html">calloutgoing.h</a>></code> <p> <p>Inheritance diagram for CallOutgoing: <p><center><img src="classCallOutgoing.png" usemap="#CallOutgoing_map" border="0" alt=""></center> <map name="CallOutgoing_map"> <area href="classCallModule.html" alt="CallModule" shape="rect" coords="0,56,85,80"> <area href="classCallInterface.html" alt="CallInterface" shape="rect" coords="0,0,85,24"> </map> <a href="classCallOutgoing-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="classCallOutgoing.html#a0">CallOutgoing</a> (<a class="el" href="classCapi.html">Capi</a> *<a class="el" href="classCallOutgoing.html#r5">capi</a>, _cdword <a class="el" href="classCallOutgoing.html#r6">controller</a>, string <a class="el" href="classCallOutgoing.html#r1">call_from</a>, string <a class="el" href="classCallOutgoing.html#r2">call_to</a>, <a class="el" href="classConnection.html#w10">Connection::service_t</a> <a class="el" href="classCallOutgoing.html#r0">service</a>, int <a class="el" href="classCallModule.html#p5">timeout</a>, string <a class="el" href="classCallOutgoing.html#r3">faxStationID</a>, string <a class="el" href="classCallOutgoing.html#r4">faxHeadline</a>, bool <a class="el" href="classCallOutgoing.html#r7">clir</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="classCallOutgoing.html#a1">mainLoop</a> () throw (CapiExternalError, CapiMsgError)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Initiate connection, wait for it to succeed. <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="classCallOutgoing.html#a2">callConnected</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Finish if we got connection. <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="classCallOutgoing.html#a3">alerting</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">activate the timeout in the moment the other party starts getting alerted <a href="#a3"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classConnection.html">Connection</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#a4">getConnection</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return reference to the established connection <a href="#a4"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#a5">getResult</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">return result of connection establishment <a href="#a5"></a><br></td></tr> <tr><td colspan=2><br><h2>Private Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classConnection.html#w10">Connection::service_t</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#r0">service</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">service with which we should connect <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="classCallOutgoing.html#r1">call_from</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">CallingPartyNumber. <a href="#r1"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>string </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#r2">call_to</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">CalledPartyNumber. <a href="#r2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>string </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#r3">faxStationID</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">fax Station ID to use <a href="#r3"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>string </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#r4">faxHeadline</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">fax headlint to use <a href="#r4"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classCapi.html">Capi</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#r5">capi</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">reference to object of <a class="el" href="classCapi.html">Capi</a> to use <a href="#r5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>_cdword </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#r6">controller</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">controller to use <a href="#r6"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#r7">clir</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">enable CLIR? (don't show own number to called party) <a href="#r7"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#r8">result</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">result of the call establishment process (0=success, 1=timeout exceeded, 2=aborted w/o reason, 0x3301-0x34FF=CAPI errors) <a href="#r8"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classCallOutgoing.html#r9">saved_timeout</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">we'll save the given timeout for later as first phase (wait for alerting) doesn't need timeout <a href="#r9"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Call Module for establishment of an outgoing connection and wait for successful connect. <p> This module serves to initiate an outgoing call and wait for the connection establishment. The module can finish for three reasons:<ul> <li>timeout for connecting exceeded</li><li>error during call setup</li><li>successful connect</li></ul> <p> The timeout will be counted from the moment the other party is alerted, not from the moment we initiate the call!<p> You can get the reason for exiting with <a class="el" href="classCallOutgoing.html#a5">getResult()</a>.<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="CallOutgoing::CallOutgoing" ></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"> CallOutgoing::CallOutgoing </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classCapi.html">Capi</a> * </td> <td class="mdname" nowrap> <em>capi</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap>_cdword </td> <td class="mdname" nowrap> <em>controller</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap>string </td> <td class="mdname" nowrap> <em>call_from</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap>string </td> <td class="mdname" nowrap> <em>call_to</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap><a class="el" href="classConnection.html#w10">Connection::service_t</a> </td> <td class="mdname" nowrap> <em>service</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>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 class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap>bool </td> <td class="mdname" nowrap> <em>clir</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>capi</em> </td><td>reference to object of <a class="el" href="classCapi.html">Capi</a> to use </td></tr> <tr><td></td><td valign=top><em>controller</em> </td><td>controller number to use </td></tr> <tr><td></td><td valign=top><em>call_from</em> </td><td>string containing the number to call </td></tr> <tr><td></td><td valign=top><em>call_to</em> </td><td>string containing the own number to use </td></tr> <tr><td></td><td valign=top><em>service</em> </td><td>service to call with as described in <a class="el" href="classConnection.html#w10">Connection::service_t</a> </td></tr> <tr><td></td><td valign=top><em>timeout</em> </td><td>timeout to wait for connection establishment </td></tr> <tr><td></td><td valign=top><em>faxStationID</em> </td><td>fax station ID, only necessary when connecting in FAXG3 mode </td></tr> <tr><td></td><td valign=top><em>faxHeadline</em> </td><td>fax headline, only necessary when connecting in FAXG3 mode </td></tr> <tr><td></td><td valign=top><em>clir</em> </td><td>set to true to disable sending of own number</td></tr> </table> </dl> </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="a3" doxytag="CallOutgoing::alerting" ></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 CallOutgoing::alerting </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> activate the timeout in the moment the other party starts getting alerted <p> <p> Reimplemented from <a class="el" href="classCallModule.html#a4">CallModule</a>. <p> </td> </tr> </table> <a class="anchor" name="a2" doxytag="CallOutgoing::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 CallOutgoing::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 if we got connection. <p> <p> Reimplemented from <a class="el" href="classCallModule.html#a5">CallModule</a>. <p> </td> </tr> </table> <a class="anchor" name="a4" doxytag="CallOutgoing::getConnection" ></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"> <a class="el" href="classConnection.html">Connection</a> * CallOutgoing::getConnection </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> return reference to the established connection <p> <dl compact><dt><b>Returns:</b></dt><dd>reference to the established connection, NULL if timout exceeded w/o successful connection</dd></dl> </td> </tr> </table> <a class="anchor" name="a5" doxytag="CallOutgoing::getResult" ></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 CallOutgoing::getResult </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> return result of connection establishment <p> 0: connection is up, call was successful 1: call timeout exceeded 2: connection not successful, no reason available 0x3301-0x34FF: connection not successful, reason given in CAPI coding. See CAPI spec for details. <dl compact><dt><b>Returns:</b></dt><dd>result, see above</dd></dl> </td> </tr> </table> <a class="anchor" name="a1" doxytag="CallOutgoing::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 CallOutgoing::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="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> Initiate connection, wait for it to succeed. <p> This call module does never throw CapiWrongState! see <a class="el" href="classCallOutgoing.html#a5">getResult()</a> if you need to know if conneciton succeeded.<p> <dl compact><dt><b>Exceptions:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>CapiExternalError</em> </td><td>Thrown by <a class="el" href="classConnection.html#a0">Connection::Connection(Capi*,_cdword,string,bool,string,service_t,string,string)</a> </td></tr> <tr><td></td><td valign=top><em>CapiMsgError</em> </td><td>Thrown by <a class="el" href="classConnection.html#a0">Connection::Connection(Capi*,_cdword,string,bool,string,service_t,string,string)</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="CallOutgoing::call_from" ></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="classCallOutgoing.html#r1">CallOutgoing::call_from</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> CallingPartyNumber. <p> </td> </tr> </table> <a class="anchor" name="r2" doxytag="CallOutgoing::call_to" ></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="classCallOutgoing.html#r2">CallOutgoing::call_to</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> CalledPartyNumber. <p> </td> </tr> </table> <a class="anchor" name="r5" doxytag="CallOutgoing::capi" ></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"> <a class="el" href="classCapi.html">Capi</a>* <a class="el" href="classCallOutgoing.html#r5">CallOutgoing::capi</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> reference to object of <a class="el" href="classCapi.html">Capi</a> to use <p> </td> </tr> </table> <a class="anchor" name="r7" doxytag="CallOutgoing::clir" ></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"> bool <a class="el" href="classCallOutgoing.html#r7">CallOutgoing::clir</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> enable CLIR? (don't show own number to called party) <p> </td> </tr> </table> <a class="anchor" name="r6" doxytag="CallOutgoing::controller" ></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"> _cdword <a class="el" href="classCallOutgoing.html#r6">CallOutgoing::controller</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> controller to use <p> </td> </tr> </table> <a class="anchor" name="r4" doxytag="CallOutgoing::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="classCallOutgoing.html#r4">CallOutgoing::faxHeadline</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> fax headlint to use <p> </td> </tr> </table> <a class="anchor" name="r3" doxytag="CallOutgoing::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="classCallOutgoing.html#r3">CallOutgoing::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> <a class="anchor" name="r8" doxytag="CallOutgoing::result" ></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="classCallOutgoing.html#r8">CallOutgoing::result</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> result of the call establishment process (0=success, 1=timeout exceeded, 2=aborted w/o reason, 0x3301-0x34FF=CAPI errors) <p> </td> </tr> </table> <a class="anchor" name="r9" doxytag="CallOutgoing::saved_timeout" ></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="classCallOutgoing.html#r9">CallOutgoing::saved_timeout</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> we'll save the given timeout for later as first phase (wait for alerting) doesn't need timeout <p> </td> </tr> </table> <a class="anchor" name="r0" doxytag="CallOutgoing::service" ></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"> <a class="el" href="classConnection.html#w10">Connection::service_t</a> <a class="el" href="classCallOutgoing.html#r0">CallOutgoing::service</a><code> [private]</code> </td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> service with which we should connect <p> </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="calloutgoing_8h-source.html">calloutgoing.h</a><li>calloutgoing.cpp</ul> <hr size="1"><address style="align: right;"><small>Generated on Sun Nov 28 14:37:44 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>