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