• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
3<title>CPV2WayProxyFactory class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5</head><body>
6<!-- Generated by Doxygen 1.2.18 -->
7<center>
8<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>
9<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>
10<p>
11<table border=0 cellpadding=0 cellspacing=0>
12<tr><td></td></tr>
13<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr>
14<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>
15<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>
16<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>
17<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>
18</table>
19<hr><h2>Member Function Documentation</h2>
20<a name="d1" doxytag="CPV2WayProxyFactory::Cleanup"></a><p>
21<table width="100%" cellpadding="2" cellspacing="0" border="0">
22  <tr>
23    <td class="md">
24      <table cellpadding="0" cellspacing="0" border="0">
25        <tr>
26          <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void CPV2WayProxyFactory::Cleanup </td>
27          <td class="md" valign="top">(&nbsp;</td>
28          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
29          <td class="md" valign="top">)&nbsp;</td>
30          <td class="md" nowrap><code> [static]</code></td>
31        </tr>
32
33      </table>
34    </td>
35  </tr>
36</table>
37<table cellspacing=5 cellpadding=0 border=0>
38  <tr>
39    <td>
40      &nbsp;
41    </td>
42    <td>
43
44<p>
45    </td>
46  </tr>
47</table>
48<a name="d2" doxytag="CPV2WayProxyFactory::CreateTerminal"></a><p>
49<table width="100%" cellpadding="2" cellspacing="0" border="0">
50  <tr>
51    <td class="md">
52      <table cellpadding="0" cellspacing="0" border="0">
53        <tr>
54          <td class="md" nowrap valign="top"> OSCL_IMPORT_REF <a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a>* CPV2WayProxyFactory::CreateTerminal </td>
55          <td class="md" valign="top">(&nbsp;</td>
56          <td class="md" nowrap valign="top"><a class="el" href="pv__2way__basic__types_8h.html#a44">TPVTerminalType</a>&nbsp;</td>
57          <td class="mdname" nowrap>&nbsp; <em>aTerminalType</em>, </td>
58        </tr>
59        <tr>
60          <td></td>
61          <td></td>
62          <td class="md" nowrap>PVCommandStatusObserver *&nbsp;</td>
63          <td class="mdname" nowrap>&nbsp; <em>aCmdStatusObserver</em>, </td>
64        </tr>
65        <tr>
66          <td></td>
67          <td></td>
68          <td class="md" nowrap>PVInformationalEventObserver *&nbsp;</td>
69          <td class="mdname" nowrap>&nbsp; <em>aInfoEventObserver</em>, </td>
70        </tr>
71        <tr>
72          <td></td>
73          <td></td>
74          <td class="md" nowrap>PVErrorEventObserver *&nbsp;</td>
75          <td class="mdname" nowrap>&nbsp; <em>aErrorEventObserver</em></td>
76        </tr>
77        <tr>
78          <td></td>
79          <td class="md">)&nbsp;</td>
80          <td class="md" colspan="2"><code> [static]</code></td>
81        </tr>
82
83      </table>
84    </td>
85  </tr>
86</table>
87<table cellspacing=5 cellpadding=0 border=0>
88  <tr>
89    <td>
90      &nbsp;
91    </td>
92    <td>
93
94<p>
95Creates an instance of a terminal of a particular type. Initially, this will support 324m type terminals.<dl compact><dt><b>Parameters: </b></dt><dd>
96<table border=0 cellspacing=2 cellpadding=0>
97<tr><td valign=top><em>aTerminalType</em>&nbsp;</td><td>
98the type of terminal to be created. </td></tr>
99<tr><td valign=top><em>aCmdStatusObserver</em>&nbsp;</td><td>
100the observer for command status </td></tr>
101<tr><td valign=top><em>aInfoEventObserver</em>&nbsp;</td><td>
102the observer for unsolicited informational events </td></tr>
103<tr><td valign=top><em>aErrorEventObserver</em>&nbsp;</td><td>
104the observer for unsolicited error events</td></tr>
105</table>
106</dl><dl compact><dt><b>Returns: </b></dt><dd>
107A pointer to a terminal or leaves if the type is invalid or the system is out of resources </dl>    </td>
108  </tr>
109</table>
110<a name="d3" doxytag="CPV2WayProxyFactory::DeleteTerminal"></a><p>
111<table width="100%" cellpadding="2" cellspacing="0" border="0">
112  <tr>
113    <td class="md">
114      <table cellpadding="0" cellspacing="0" border="0">
115        <tr>
116          <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void CPV2WayProxyFactory::DeleteTerminal </td>
117          <td class="md" valign="top">(&nbsp;</td>
118          <td class="md" nowrap valign="top"><a class="el" href="classCPV2WayInterface.html">CPV2WayInterface</a> *&nbsp;</td>
119          <td class="mdname1" valign="top" nowrap>&nbsp; <em>terminal</em>          </td>
120          <td class="md" valign="top">)&nbsp;</td>
121          <td class="md" nowrap><code> [static]</code></td>
122        </tr>
123
124      </table>
125    </td>
126  </tr>
127</table>
128<table cellspacing=5 cellpadding=0 border=0>
129  <tr>
130    <td>
131      &nbsp;
132    </td>
133    <td>
134
135<p>
136This 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>
137<table border=0 cellspacing=2 cellpadding=0>
138<tr><td valign=top><em>terminal</em>&nbsp;</td><td>
139the terminal to be deleted. </td></tr>
140</table>
141</dl>    </td>
142  </tr>
143</table>
144<a name="d0" doxytag="CPV2WayProxyFactory::Init"></a><p>
145<table width="100%" cellpadding="2" cellspacing="0" border="0">
146  <tr>
147    <td class="md">
148      <table cellpadding="0" cellspacing="0" border="0">
149        <tr>
150          <td class="md" nowrap valign="top"> OSCL_IMPORT_REF void CPV2WayProxyFactory::Init </td>
151          <td class="md" valign="top">(&nbsp;</td>
152          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
153          <td class="md" valign="top">)&nbsp;</td>
154          <td class="md" nowrap><code> [static]</code></td>
155        </tr>
156
157      </table>
158    </td>
159  </tr>
160</table>
161<table cellspacing=5 cellpadding=0 border=0>
162  <tr>
163    <td>
164      &nbsp;
165    </td>
166    <td>
167
168<p>
169    </td>
170  </tr>
171</table>
172<hr>The documentation for this class was generated from the following file:<ul>
173<li><a class="el" href="pv__2way__proxy__factory_8h-source.html">pv_2way_proxy_factory.h</a></ul>
174<hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>PV2Way Engine</small>
175<address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small>
176</small></address>
177</body>
178</html>
179