blob: f487aad48bf078ddf56b684322286f0198b5f1b5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CPV2WayProxyFactory class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.2.18 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Data Structures</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Data Fields</a> &nbsp; <a class="qindex" href="globals.html">Globals</a> &nbsp; </center>
<hr><h1>CPV2WayProxyFactory Class Reference</h1><code>#include &lt;<a class="el" href="pv__2way__proxy__factory_8h-source.html">pv_2way_proxy_factory.h</a>&gt;</code>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void&nbsp;</td><td valign=bottom><a class="el" href="classCPV2WayProxyFactory.html#d0">Init</a> ()</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void&nbsp;</td><td valign=bottom><a class="el" href="classCPV2WayProxyFactory.html#d1">Cleanup</a> ()</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF <a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a> *&nbsp;</td><td valign=bottom><a class="el" href="classCPV2WayProxyFactory.html#d2">CreateTerminal</a> (<a class="el" href="pv__2way__basic__types_8h.html#a44">TPVTerminalType</a> aTerminalType, PVCommandStatusObserver *aCmdStatusObserver, PVInformationalEventObserver *aInfoEventObserver, PVErrorEventObserver *aErrorEventObserver)</td></tr>
<tr><td nowrap align=right valign=top>OSCL_IMPORT_REF void&nbsp;</td><td valign=bottom><a class="el" href="classCPV2WayProxyFactory.html#d3">DeleteTerminal</a> (<a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a> *terminal)</td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="d1" doxytag="CPV2WayProxyFactory::Cleanup"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF void CPV2WayProxyFactory::Cleanup </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="d2" doxytag="CPV2WayProxyFactory::CreateTerminal"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a>* CPV2WayProxyFactory::CreateTerminal </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="pv__2way__basic__types_8h.html#a44">TPVTerminalType</a>&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aTerminalType</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>PVCommandStatusObserver *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aCmdStatusObserver</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>PVInformationalEventObserver *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aInfoEventObserver</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>PVErrorEventObserver *&nbsp;</td>
<td class="mdname" nowrap>&nbsp; <em>aErrorEventObserver</em></td>
</tr>
<tr>
<td></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Creates an instance of a terminal of a particular type. Initially, this will support 324m type terminals.<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>aTerminalType</em>&nbsp;</td><td>
the type of terminal to be created. </td></tr>
<tr><td valign=top><em>aCmdStatusObserver</em>&nbsp;</td><td>
the observer for command status </td></tr>
<tr><td valign=top><em>aInfoEventObserver</em>&nbsp;</td><td>
the observer for unsolicited informational events </td></tr>
<tr><td valign=top><em>aErrorEventObserver</em>&nbsp;</td><td>
the observer for unsolicited error events</td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
A pointer to a terminal or leaves if the type is invalid or the system is out of resources </dl> </td>
</tr>
</table>
<a name="d3" doxytag="CPV2WayProxyFactory::DeleteTerminal"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF void CPV2WayProxyFactory::DeleteTerminal </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a> *&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; <em>terminal</em> </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This function allows the application to delete an instance of a terminal and reclaim all allocated resources. A terminal should be deleted only in the EIdle state. An attempt to delete a terminal in any other state will result in unpredictable behavior.<dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>terminal</em>&nbsp;</td><td>
the terminal to be deleted. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="d0" doxytag="CPV2WayProxyFactory::Init"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> OSCL_IMPORT_REF void CPV2WayProxyFactory::Init </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="mdname1" valign="top" nowrap>&nbsp; </td>
<td class="md" valign="top">)&nbsp;</td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="pv__2way__proxy__factory_8h-source.html">pv_2way_proxy_factory.h</a></ul>
<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV2Way Engine</small>
<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
</small></address>
</body>
</html>