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::rdt::CTR</title> 49 </head> 50 <body> 51<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/rdt/Overview.html">rdt</a>::CTR</CODE> Namespace</h1> 52<h2>Description</h2> 53 <div class="section"> 54<p>The <a href="../../../nn/rdt/CTR/Overview.html">CTR</a> RDT (reliable local communication) namespace.</p><!-- write here --></div> 55 <a name="class" id="class"> 56<h2>Classes</h2> 57 <div class="section"> 58 <table class="members"> 59 <tr> 60 <th> 61<a href="../../../nn/rdt/CTR/Receiver/Overview.html"><CODE>nn::rdt::CTR::Receiver</CODE></a> 62 </th> 63<td>Class that represents a device that receives data.</td> 64 </tr> 65 <tr> 66 <th> 67<a href="../../../nn/rdt/CTR/Sender/Overview.html"><CODE>nn::rdt::CTR::Sender</CODE></a> 68 </th> 69<td>Class that represents a device that sends data.</td> 70 </tr> 71 <tr> 72 <th> 73<a href="../../../nn/rdt/CTR/ResultAlreadyInitialized/Overview.html"><CODE>nn::rdt::CTR::ResultAlreadyInitialized</CODE></a> 74 </th> 75<td>Indicates that a function exited without doing anything because initialization had already finished (this is not an error).</td> 76 </tr> 77 <tr> 78 <th> 79<a href="../../../nn/rdt/CTR/ResultDoNothing/Overview.html"><CODE>nn::rdt::CTR::ResultDoNothing</CODE></a> 80 </th> 81<td>Indicates that a function exited without doing anything (this is not an error).</td> 82 </tr> 83 <tr> 84 <th> 85<a href="../../../nn/rdt/CTR/ResultNotInitialized/Overview.html"><CODE>nn::rdt::CTR::ResultNotInitialized</CODE></a> 86 </th> 87<td>Indicates an uninitialized instance.</td> 88 </tr> 89 <tr> 90 <th> 91<a href="../../../nn/rdt/CTR/ResultSendBufferIsNotAvailable/Overview.html"><CODE>nn::rdt::CTR::ResultSendBufferIsNotAvailable</CODE></a> 92 </th> 93<td>Indicates that the <a href="../../../nn/rdt/CTR/Sender/Send.html"><CODE>Sender::Send</CODE></a> function attempted to write data to the send buffer, but the send buffer did not have enough free space.</td> 94 </tr> 95 <tr> 96 <th> 97<a href="../../../nn/rdt/CTR/ResultInvalidSize/Overview.html"><CODE>nn::rdt::CTR::ResultInvalidSize</CODE></a> 98 </th> 99<td>Indicates that an invalid size was specified as an argument.</td> 100 </tr> 101 <tr> 102 <th> 103<a href="../../../nn/rdt/CTR/ResultMisalignedAddress/Overview.html"><CODE>nn::rdt::CTR::ResultMisalignedAddress</CODE></a> 104 </th> 105<td>Indicates that a memory address with an invalid alignment was passed as an argument.</td> 106 </tr> 107 <tr> 108 <th> 109<a href="../../../nn/rdt/CTR/ResultNullPointer/Overview.html"><CODE>nn::rdt::CTR::ResultNullPointer</CODE></a> 110 </th> 111<td>Indicates an error caused by specifying a null pointer as an argument.</td> 112 </tr> 113 <tr> 114 <th> 115<a href="../../../nn/rdt/CTR/ResultResetReceived/Overview.html"><CODE>nn::rdt::CTR::ResultResetReceived</CODE></a> 116 </th> 117<td>Indicates that a reset signal was received from a peer and there was a state transition to <CODE>CLOSED</CODE>.</td> 118 </tr> 119 <tr> 120 <th> 121<a href="../../../nn/rdt/CTR/ResultResendQueueIsFull/Overview.html"><CODE>nn::rdt::CTR::ResultResendQueueIsFull</CODE></a> 122 </th> 123<td>Indicates that the RDT library's internal resend queue was full.</td> 124 </tr> 125 <tr> 126 <th> 127<a href="../../../nn/rdt/CTR/ResultUntimelyFunctionCall/Overview.html"><CODE>nn::rdt::CTR::ResultUntimelyFunctionCall</CODE></a> 128 </th> 129<td>Indicates that a function was called when it should not have been.</td> 130 </tr> 131 <tr> 132 <th> 133<a href="../../../nn/rdt/CTR/ResultNoData/Overview.html"><CODE>nn::rdt::CTR::ResultNoData</CODE></a> 134 </th> 135<td>A result code that is used only within the library. Indicates that no segments have been received (no segments have arrived yet).</td> 136 </tr> 137 <tr> 138 <th> 139<a href="../../../nn/rdt/CTR/ResultInvalidValue/Overview.html"><CODE>nn::rdt::CTR::ResultInvalidValue</CODE></a> 140 </th> 141<td>A result code that indicates that an argument value was invalid.</td> 142 </tr> </table> 143 </div> 144 </a> <a name="struct" id="struct"> 145<h2>Structures</h2> 146 <div class="section"> 147 <table class="members"> 148 <tr> 149 <th> 150<a href="../../../nn/rdt/CTR/ReceiverConfig/Overview.html"><CODE>nn::rdt::CTR::ReceiverConfig</CODE></a> 151 </th> 152<td>Structure that contains all configuration information passed to <CODE>Initialize</CODE>.</td> 153 </tr> 154 <tr> 155 <th> 156<a href="../../../nn/rdt/CTR/SenderConfig/Overview.html"><CODE>nn::rdt::CTR::SenderConfig</CODE></a> 157 </th> 158<td>Structure that contains all configuration information passed to <CODE>Initialize</CODE>.</td> 159 </tr> </table> 160 </div> 161 </a> <a name="enum" id="enum"> 162<h2>Enumerated Types</h2> 163 <div class="section"> 164 <table class="members"> 165 <tr> 166 <td width="100"> </td> 167 <th> 168<a href="../../../nn/rdt/CTR/SenderState.html"><CODE>SenderState</CODE></a> 169 </th> 170<td>Enumerated type that indicates the state of a <CODE>Sender</CODE> instance.</td> 171 </tr> 172 <tr> 173 <td width="100"> </td> 174 <th> 175<a href="../../../nn/rdt/CTR/ReceiverState.html"><CODE>ReceiverState</CODE></a> 176 </th> 177<td>Enumerated type that indicates the state of a <CODE>Receiver</CODE> instance.</td> 178 </tr> </table> 179 </div> 180 </a> <a name="constant" id="constant"> 181<h2>Constants</h2> 182 <div class="section"> 183 <table class="members"> 184 <tr> 185 <td width="100"> </td> 186 <th> 187<span class="argument"><a href="../../../nn/rdt/CTR/LOG_LEVEL_NONE.html"><CODE>LOG_LEVEL_NONE</CODE></a></span> 188 </th> 189<td width="100">const <a href="../../../nn_types/bit32.html">bit32</a></td> 190<td>Constant that indicates that a log will not in any way be output.</td> 191 </tr> 192 <tr> 193 <td width="100"> </td> 194 <th> 195<span class="argument"><a href="../../../nn/rdt/CTR/LOG_LEVEL_ALL.html"><CODE>LOG_LEVEL_ALL</CODE></a></span> 196 </th> 197<td width="100">const <a href="../../../nn_types/bit32.html">bit32</a></td> 198<td>Constant that indicates that all logs will be output.</td> 199 </tr> </table> 200 </div> 201 </a> <a name="function" id="function"> 202<h2>Functions</h2> 203 <div class="section"> 204 <table class="members"> 205 <tr> 206 <td width="100"> </td> 207 <th> 208<a href="../../../nn/rdt/CTR/SetLogLevel.html">SetLogLevel</a> 209 </th> 210<td>Configures the RDT library's log output level.</td> 211 </tr> 212 <tr> 213 <td width="100"> </td> 214 <th> 215<a href="../../../nn/rdt/CTR/GetLogLevel.html">GetLogLevel</a> 216 </th> 217<td>Gets the log output level configured for the RDT library.</td> 218 </tr> </table> 219 </div> 220 </a> 221<h2>Revision History</h2> 222 <div class="section"> 223 <dl class="history"> 224 <dt>2010/06/14</dt> 225<dd>Initial version.<br /> 226 </dd> 227 </dl> 228 </div> 229 <hr><p>CONFIDENTIAL</p></body> 230</html> 231