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::SerialChannel</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>::SerialChannel</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 SerialChannel</pre> 57 </div> 58<h2>Description</h2> 59 <div class="section"> 60<p>Class that represents the channels used for serial communication.</p><p>The CTR target board can communicate with a PC by opening serial communication using the same channel on both sides.</p><p>The device initiating communication calls <a href="../../../../nn/hio/CTR/SerialChannel/Connect.html"><CODE>Connect</CODE></a>, and the device waiting for communication calls <a href="../../../../nn/hio/CTR/SerialChannel/WaitHost.html"><CODE>WaitHost</CODE></a>. For example, if the CTR calls <CODE>Connect</CODE>, the PC must call <CODE>WaitHost</CODE>.</p><!-- write here --></div> 61 <a name="enum" id="enum"> 62<h2>Enumerated Types</h2> 63 <div class="section"> 64 <table class="members"> 65 <tr> 66 <td width="100"> </td> 67 <th> 68<a href="../../../../nn/hio/CTR/SerialChannel/Attribute.html"><CODE>Attribute</CODE></a> 69 </th> 70<td>Enumerated type that represents sending/reception attributes.</td> 71 </tr> </table> 72 </div> 73 </a> <a name="function" id="function"> 74<h2>Member Functions</h2> 75 <div class="section"> 76 <table class="members"> 77 <tr> 78 <td width="100"> </td> 79 <th> 80<a href="../../../../nn/hio/CTR/SerialChannel/SerialChannel.html"><CODE>SerialChannel</CODE></a> 81 </th> 82<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> 83 </tr> 84 <tr> 85 <td width="100"> </td> 86 <th> 87<a href="../../../../nn/hio/CTR/SerialChannel/~SerialChannel.html"><CODE>~SerialChannel</CODE></a> 88 </th> 89<td>Destructor. Closes a channel if it is open.</td> 90 </tr> 91 <tr> 92 <td width="100"> </td> 93 <th> 94<a href="../../../../nn/hio/CTR/SerialChannel/Open.html"><CODE>Open</CODE></a> 95 </th> 96<td>Opens a channel.</td> 97 </tr> 98 <tr> 99 <td width="100"> </td> 100 <th> 101<a href="../../../../nn/hio/CTR/SerialChannel/Close.html"><CODE>Close</CODE></a> 102 </th> 103<td>Closes the channel.</td> 104 </tr> 105 <tr> 106 <td width="100"> </td> 107 <th> 108<a href="../../../../nn/hio/CTR/SerialChannel/Connect.html"><CODE>Connect</CODE></a> 109 </th> 110<td>Connects to a host. Blocks until the host calls <CODE>Wait</CODE>.</td> 111 </tr> 112 <tr> 113 <td width="100"> </td> 114 <th> 115<a href="../../../../nn/hio/CTR/SerialChannel/WaitHost.html"><CODE>WaitHost</CODE></a> 116 </th> 117<td>Waits for a connection from the host.</td> 118 </tr> 119 <tr> 120 <td width="100"> </td> 121 <th> 122<a href="../../../../nn/hio/CTR/SerialChannel/Disconnect.html"><CODE>Disconnect</CODE></a> 123 </th> 124<td>Disconnects from the host.</td> 125 </tr> 126 <tr> 127 <td width="100"> </td> 128 <th> 129<a href="../../../../nn/hio/CTR/SerialChannel/Flush.html"><CODE>Flush</CODE></a> 130 </th> 131<td>Waits until the send buffer is empty. This does not involve the status of the host's receive buffer.</td> 132 </tr> 133 <tr> 134 <td width="100"> </td> 135 <th> 136<a href="../../../../nn/hio/CTR/SerialChannel/GetReadableSize.html"><CODE>GetReadableSize</CODE></a> 137 </th> 138<td>Gets the loadable size from the buffer(s) and returns the result of the operation.</td> 139 </tr> 140 <tr> 141 <td width="100"> </td> 142 <th> 143<a href="../../../../nn/hio/CTR/SerialChannel/Read.html"><CODE>Read</CODE></a> 144 </th> 145<td>Receives data from the host and returns the result of the operation.</td> 146 </tr> 147 <tr> 148 <td width="100"> </td> 149 <th> 150<a href="../../../../nn/hio/CTR/SerialChannel/GetWritableSize.html"><CODE>GetWritableSize</CODE></a> 151 </th> 152<td>Gets the size of data that can be written to the buffer(s) and returns the result of the operation.</td> 153 </tr> 154 <tr> 155 <td width="100"> </td> 156 <th> 157<a href="../../../../nn/hio/CTR/SerialChannel/Write.html"><CODE>Write</CODE></a> 158 </th> 159<td>Sends data to the host and returns the result of the operation.</td> 160 </tr> </table> 161 </div> 162 </a> 163<h2>Revision History</h2> 164 <div class="section"> 165 <dl class="history"> 166 <dt>2010/06/14</dt> 167<dd>Added descriptions of the various functions.<br /> 168 </dd> 169 <dt>2010/03/31</dt> 170<dd>Initial version.<br /> 171 </dd> 172 </dl> 173 </div> 174 <hr><p>CONFIDENTIAL</p></body> 175</html> 176