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>nn::hio::CTR::SharedMemoryChannel</title>
49  </head>
50  <body>
51<h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/hio/Overview.html">hio</a>::<a href="../../../../nn/hio/CTR/Overview.html">CTR</a>::SharedMemoryChannel</CODE> Class</h1>
52    <div class="section">
53<b>Header file: </b>nn/hio.h</div>
54<h2>Syntax</h2>
55    <div class="section">
56<pre class="definition">class SharedMemoryChannel</pre>
57    </div>
58<h2>Description</h2>
59    <div class="section">
60<p>Class that represents the channels used for shared memory.</p><p>The CTR target board can communicate with a PC by opening the same channel on both sides to use for shared memory.</p><p>With both devices have the same channel open, they can use shared memory.</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            <td width="100">  </td>
67            <th>
68<a href="../../../../nn/hio/CTR/SharedMemoryChannel/SharedMemoryChannel.html"><CODE>SharedMemoryChannel</CODE></a>
69            </th>
70<td>Constructor. You must make a separate call to <a href="../../../../nn/hio/CTR/SerialChannel/Open.html"><CODE>Open</CODE></a> to open a channel.</td>
71          </tr>
72          <tr>
73            <td width="100">  </td>
74            <th>
75<a href="../../../../nn/hio/CTR/SharedMemoryChannel/~SharedMemoryChannel.html"><CODE>~SharedMemoryChannel</CODE></a>
76            </th>
77<td>Destructor. Closes a channel if it is open.</td>
78          </tr>
79          <tr>
80            <td width="100">  </td>
81            <th>
82<a href="../../../../nn/hio/CTR/SharedMemoryChannel/Open.html"><CODE>Open</CODE></a>
83            </th>
84<td>Opens a channel.</td>
85          </tr>
86          <tr>
87            <td width="100">  </td>
88            <th>
89<a href="../../../../nn/hio/CTR/SharedMemoryChannel/Close.html"><CODE>Close</CODE></a>
90            </th>
91<td>Closes the channel.</td>
92          </tr>
93          <tr>
94            <td width="100">  </td>
95            <th>
96<a href="../../../../nn/hio/CTR/SharedMemoryChannel/GetSpaceSize.html"><CODE>GetSpaceSize</CODE></a>
97            </th>
98<td>Gets the size of the shared memory.</td>
99          </tr>
100          <tr>
101            <td width="100">  </td>
102            <th>
103<a href="../../../../nn/hio/CTR/SharedMemoryChannel/Read.html"><CODE>Read</CODE></a>
104            </th>
105<td>Reads data from shared memory and returns the result of the operation.</td>
106          </tr>
107          <tr>
108            <td width="100">  </td>
109            <th>
110<a href="../../../../nn/hio/CTR/SharedMemoryChannel/Write.html"><CODE>Write</CODE></a>
111            </th>
112<td>Writes data to shared memory and returns the result of the operation.</td>
113          </tr> </table>
114      </div>
115    </a>
116<h2>Revision History</h2>
117    <div class="section">
118      <dl class="history">
119        <dt>2010/03/31</dt>
120<dd>Initial version.<br />
121        </dd>
122      </dl>
123    </div>
124  <hr><p>CONFIDENTIAL</p></body>
125</html>
126