1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21
22      span.virtual_style
23      {
24        font-size			 : 8pt;
25        color				 : white;
26        font-weight			: bold;
27        background			: #0a0;
28        border-left			: solid 1px #0f0;
29        border-top			: solid 1px #0f0;
30        border-right		: solid 1px #060;
31        border-bottom		: solid 1px #060;
32        padding-left		: 2px;
33        padding-right		: 2px;
34      }
35
36      span.protected_style
37      {
38        font-size			 : 8pt;
39        color				 : white;
40        font-weight			: bold;
41        background			: #444;
42        border-left			: solid 1px #ccc;
43        border-top			: solid 1px #ccc;
44        border-right		: solid 1px #222;
45        border-bottom		: solid 1px #222;
46        padding-left		: 2px;
47        padding-right		: 2px;
48      }
49        --></style>
50<title>CDEVHIO</title>
51  </head>
52  <body>
53<h1><CODE>CDEVHIO</CODE> Class</h1>
54    <div class="section">
55<b>Header file: </b>kmc/hio/CDevHIO.h</div>
56<h2>Syntax</h2>
57    <div class="section">
58      <pre class="definition">class CDEVHIO</pre>
59    </div>
60<h2>Description</h2>
61    <div class="section">
62<p>Class that provides Host IO functionality.</p><!-- write here --></div>
63    <a name="function" id="function">
64<h2>Member Functions</h2>
65      <div class="section">
66        <table class="members">
67          <tr>
68<th class="category" colspan="3">Device Search and Connection</th>
69          </tr>
70          <tr>
71            <td width="100">  </td>
72            <th>
73<a href="../CDEVHIO/Find.html"><CODE>Find</CODE></a>
74            </th>
75<td>Searches for connectable devices.</td>
76          </tr>
77          <tr>
78            <td width="100">  </td>
79            <th>
80<a href="../CDEVHIO/Connect.html"><CODE>Connect</CODE></a>
81            </th>
82<td>Starts a Host IO connection with a device.</td>
83          </tr>
84          <tr>
85            <td width="100">  </td>
86            <th>
87<a href="../CDEVHIO/Disconnect.html"><CODE>Disconnect</CODE></a>
88            </th>
89<td>Ends a Host IO connection.</td>
90          </tr>
91          <tr>
92            <td width="100">  </td>
93            <th>
94<a href="../CDEVHIO/GetConnectId.html"><CODE>GetConnectId</CODE></a>
95            </th>
96<td>Gets the ID of the currently connected device.</td>
97          </tr>
98          <tr>
99<th class="category" colspan="3">Serial Communication</th>
100          </tr>
101          <tr>
102            <td width="100">  </td>
103            <th>
104<a href="../CDEVHIO/OpenSio.html"><CODE>OpenSio</CODE></a>
105            </th>
106<td>Opens a serial communication channel.</td>
107          </tr>
108          <tr>
109            <td width="100">  </td>
110            <th>
111<a href="../CDEVHIO/CloseSio.html"><CODE>CloseSio</CODE></a>
112            </th>
113<td>Closes a serial communication channel.</td>
114          </tr>
115          <tr>
116            <td width="100">  </td>
117            <th>
118<a href="../CDEVHIO/ConnectSio.html"><CODE>ConnectSio</CODE></a>
119            </th>
120<td>Starts a connection for serial communication and waits until the target device calls <CODE>wait</CODE>.</td>
121          </tr>
122          <tr>
123            <td width="100">  </td>
124            <th>
125<a href="../CDEVHIO/WaitSio.html"><CODE>WaitSio</CODE></a>
126            </th>
127<td>Waits until the target device for serial communication calls <CODE>connect</CODE>.</td>
128          </tr>
129          <tr>
130            <td width="100">  </td>
131            <th>
132<a href="../CDEVHIO/DisconnectSio.html"><CODE>DisconnectSio</CODE></a>
133            </th>
134<td>Disconnects from a serial communication session.</td>
135          </tr>
136          <tr>
137            <td width="100">  </td>
138            <th>
139<a href="../CDEVHIO/FlushSio.html"><CODE>FlushSio</CODE></a>
140            </th>
141<td>Waits until all outgoing data has been sent during serial communication.</td>
142          </tr>
143          <tr>
144            <td width="100">  </td>
145            <th>
146<a href="../CDEVHIO/ReadSio.html"><CODE>ReadSio</CODE></a>
147            </th>
148<td>Receives data via serial communication.</td>
149          </tr>
150          <tr>
151            <td width="100">  </td>
152            <th>
153<a href="../CDEVHIO/WriteSio.html"><CODE>WriteSio</CODE></a>
154            </th>
155<td>Sends data via serial communication.</td>
156          </tr>
157          <tr>
158<th class="category" colspan="3">Shared Memory</th>
159          </tr>
160          <tr>
161            <td width="100">  </td>
162            <th>
163<a href="../CDEVHIO/OpenSmem.html"><CODE>OpenSmem</CODE></a>
164            </th>
165<td>Opens a shared memory channel.</td>
166          </tr>
167          <tr>
168            <td width="100">  </td>
169            <th>
170<a href="../CDEVHIO/CloseSmem.html"><CODE>CloseSmem</CODE></a>
171            </th>
172<td>Closes a shared memory channel.</td>
173          </tr>
174          <tr>
175            <td width="100">  </td>
176            <th>
177<a href="../CDEVHIO/GetSmemSize.html"><CODE>GetSmemSize</CODE></a>
178            </th>
179<td>Gets the size of the shared memory.</td>
180          </tr>
181          <tr>
182            <td width="100">  </td>
183            <th>
184<a href="../CDEVHIO/ReadSmem.html"><CODE>ReadSmem</CODE></a>
185            </th>
186<td>Loads data from shared memory.</td>
187          </tr>
188          <tr>
189            <td width="100">  </td>
190            <th>
191<a href="../CDEVHIO/WriteSmem.html"><CODE>WriteSmem</CODE></a>
192            </th>
193<td>Writes data in shared memory.</td>
194          </tr>
195          <tr>
196<th class="category" colspan="3">Other Functions</th>
197          </tr>
198          <tr>
199            <td width="100">  </td>
200            <th>
201<a href="../CDEVHIO/CDEVHIO.html"><CODE>CDEVHIO</CODE></a>
202            </th>
203<td>Initializes Host IO for use.</td>
204          </tr>
205          <tr>
206<td width="100"> <span class="virtual_style" title="virtual">V</span>
207            </td>
208            <th>
209<a href="../CDEVHIO/~CDEVHIO.html"><CODE>~CDEVHIO</CODE></a>
210            </th>
211<td>Ends Host IO.</td>
212          </tr>
213          <tr>
214            <td width="100">  </td>
215            <th>
216<a href="../CDEVHIO/GetVersion.html"><CODE>GetVersion</CODE></a>
217            </th>
218<td>Gets the version number.</td>
219          </tr> </table>
220      </div>
221    </a>
222<h2>Revision History</h2>
223    <div class="section">
224      <dl class="history">
225        <dt>2010/08/16</dt>
226<dd>Initial version.<br />
227        </dd>
228      </dl>
229    </div>
230  <hr><p>CONFIDENTIAL</p></body>
231</html>