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