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::uds::CTR</title>
51  </head>
52  <body>
53<h1><CODE>nn::uds::CTR</CODE> Namespace</h1>
54<h2>Description</h2>
55    <div class="section">
56<p>The <a href="../../../nn/uds/CTR/Overview.html">CTR</a> UDS (local communication) namespace. <br />(This can also be written without the &quot;<CODE>::CTR</CODE>&quot; portion.)</p><p>
57This library is used to run UDS communication, Nintendo's unique local wireless communication. For details on UDS communication, see the programming manuals.
58</p><h2> Notes</h2><h3> Function Blocking </h3><p>
59Except for the <CODE>GetLinkLevel</CODE> function, all functions of the <CODE>UDS</CODE> library can sometimes block processing for several milliseconds (any longer blocking times are described in the function reference).
60            </p><p>
61Note that this can cause problems such as unstable frame rates when these functions are called within the main thread.
62</p><h3> Sleep Mode During UDS Communication</h3><h4> Sleep Mode Is Prohibited During <CODE>Initialize</CODE> </h4><p>
63Do not enter Sleep Mode while the <CODE>Initialize</CODE> function is running. The process of transitioning the communication system to UDS mode may conflict with background communication processing when the system enters Sleep Mode, resulting in incorrect behavior.
64</p><h4> Sleep Mode Transitions During Communication </h4><p>
65Because the system cannot maintain UDS communication during Sleep Mode, applications must shut down the UDS library before allowing the system to enter Sleep Mode.
66            </p><p>
67If the system enters Sleep Mode without shutting down the UDS library, the UDS library forces all communication in progress to end immediately before the entire system enters Sleep Mode, resulting in an internal state of <CODE>STATE_ERROR</CODE>. Once the library has fallen into this state, all functions except for a few (such as <CODE>Finalize</CODE> and <CODE>GetConnectionStatus</CODE>) return an error.
68</p><h3> Guaranteeing Packet Arrival </h3><p>
69The UDS library itself does not guarantee that packets have actually been sent to the destination. A packet loss of approximately 1-2% is normal and in some cases may be 10%. Do not use code that assumes the packets you send will always reach the destination.
70</p><h3> Packet Order </h3><p>
71As long as packets are sent to the same node with the same options specified, they are guaranteed to be sent in the same order. When the packets are addressed to <CODE>BROADCAST_NODE_ID</CODE> or certain nodes, the order in which they are sent and received may be swapped. Similarly, the order in which they are sent and received may also be swapped when you switch between using the <CODE>FORCE_DIRECT_BC</CODE> and <CODE>FORCE_UNICAST</CODE> options.
72            </p></div>
73    <a name="class" id="class">
74<h2>Classes</h2>
75      <div class="section">
76        <table class="members">
77          <tr>
78<th class="category" colspan="2">Handling the Results of the Scan Function</th>
79          </tr>
80          <tr>
81            <th>
82<a href="../../../nn/uds/CTR/NetworkDescription/Overview.html"><CODE>nn::uds::CTR::NetworkDescription</CODE></a>
83            </th>
84<td>Class indicating network information that can be obtained using <a href="../../../../nn/uds/CTR/NetworkDescriptionReader/Overview.html"><CODE>nn::uds::CTR::NetworkDescriptionReader</CODE></a>.</td>
85          </tr>
86          <tr>
87            <th>
88<a href="../../../nn/uds/CTR/NetworkDescriptionReader/Overview.html"><CODE>nn::uds::CTR::NetworkDescriptionReader</CODE></a>
89            </th>
90<td>Class for analyzing all types of network information that can be obtained using <a href="../../../nn/uds/CTR/ScanResultReader/Overview.html"><CODE>nn::uds::CTR::ScanResultReader</CODE></a>.</td>
91          </tr>
92          <tr>
93            <th>
94<a href="../../../nn/uds/CTR/ScanResultReader/Overview.html"><CODE>nn::uds::CTR::ScanResultReader</CODE></a>
95            </th>
96<td>Class for analyzing the scan results obtained by <a href="../../../nn/uds/CTR/Scan.html"><CODE>nn::uds::CTR::Scan</CODE></a>.</td>
97          </tr>
98          <tr>
99<th class="category" colspan="2"><CODE>Result</CODE></th>
100          </tr>
101          <tr>
102            <th>
103<a href="../../../nn/uds/CTR/ResultNotFoundNetwork/Overview.html"><CODE>nn::uds::CTR::ResultNotFoundNetwork</CODE></a>
104            </th>
105<td>Indicates that the network to which a connection was attempted using <CODE>ConnectNetwork</CODE> was not found.</td>
106          </tr>
107          <tr>
108            <th>
109<a href="../../../nn/uds/CTR/ResultAlreadyNetworkIsFull/Overview.html"><CODE>nn::uds::CTR::ResultAlreadyNetworkIsFull</CODE></a>
110            </th>
111<td>Indicates that the network to which a connection was attempted using <CODE>ConnectNetwork</CODE> is full (the number of devices connected to that network has already reached the maximum).</td>
112          </tr>
113          <tr>
114            <th>
115<a href="../../../nn/uds/CTR/ResultDeniedFromMaster/Overview.html"><CODE>nn::uds::CTR::ResultDeniedFromMaster</CODE></a>
116            </th>
117<td>Indicates that the attempt to connect to the network using <CODE>ConnectNetwork</CODE> was denied by the master for some reason.</td>
118          </tr>
119          <tr>
120            <th>
121<a href="../../../nn/uds/CTR/ResultConnectionTimeout/Overview.html"><CODE>nn::uds::CTR::ResultConnectionTimeout</CODE></a>
122            </th>
123<td>Indicates that the attempted connection to the network made using <CODE>ConnectNetwork</CODE> timed out during the connection process.</td>
124          </tr>
125          <tr>
126            <th>
127<a href="../../../nn/uds/CTR/ResultInvalidState/Overview.html"><CODE>nn::uds::CTR::ResultInvalidState</CODE></a>
128            </th>
129<td>Indicates that the library is not in a state in which a function could be run. This can also occur if the connection cuts out during communication.</td>
130          </tr>
131          <tr>
132            <th>
133<a href="../../../nn/uds/CTR/ResultInvalidNode/Overview.html"><CODE>nn::uds::CTR::ResultInvalidNode</CODE></a>
134            </th>
135<td>Indicates that the node with the specified node ID does not exist on the network. This can also occur when the node attempts to send a packet to itself or when the connection target disconnects from the network.</td>
136          </tr>
137          <tr>
138            <th>
139<a href="../../../nn/uds/CTR/ResultOutOfResource/Overview.html"><CODE>nn::uds::CTR::ResultOutOfResource</CODE></a>
140            </th>
141<td>Indicates that the library is out of resources. This can occur if the total size of the receive buffer specified by the <a href="../../../nn/uds/CTR/Attach.html"><CODE>Attach</CODE></a> function exceeds that of the buffer specified when the <a href="../../../nn/uds/CTR/Initialize.html"><CODE>Initialize</CODE></a> function was called.</td>
142          </tr>
143          <tr>
144            <th>
145<a href="../../../nn/uds/CTR/ResultBufferIsFull/Overview.html"><CODE>nn::uds::CTR::ResultBufferIsFull</CODE></a>
146            </th>
147<td>This mostly occurs if <a href="../../../nn/uds/CTR/SendTo.html"><CODE>SendTo</CODE></a> is called with high frequency, and send operations get backed up. The data being sent will be lost if an error occurs.</td>
148          </tr>
149          <tr>
150            <th>
151<a href="../../../nn/uds/CTR/ResultWirelessOff/Overview.html"><CODE>nn::uds::CTR::ResultWirelessOff</CODE></a>
152            </th>
153<td>Indicates that a transition to wireless OFF mode occurred after initializing the UDS library.</td>
154          </tr>
155          <tr>
156            <th>
157<a href="../../../nn/uds/CTR/ResultNotInitialized/Overview.html"><CODE>nn::uds::CTR::ResultNotInitialized</CODE></a>
158            </th>
159<td>Indicates that the library has not been initialized. This error can be resolved by calling the <CODE>Initialize</CODE> function.</td>
160          </tr>
161          <tr>
162            <th>
163<a href="../../../nn/uds/CTR/ResultAlreadyOccupiedWirelessDevice/Overview.html"><CODE>nn::uds::CTR::ResultAlreadyOccupiedWirelessDevice</CODE></a>
164            </th>
165<td>Indicates that UDS communication cannot be used at the moment because other communication is already in progress.</td>
166          </tr>
167          <tr>
168            <th>
169<a href="../../../nn/uds/CTR/ResultOutOfRange/Overview.html"><CODE>nn::uds::CTR::ResultOutOfRange</CODE></a>
170            </th>
171<td>Indicates that one or more of the arguments were set to values outside their valid ranges.</td>
172          </tr>
173          <tr>
174            <th>
175<a href="../../../nn/uds/CTR/ResultTooLarge/Overview.html"><CODE>nn::uds::CTR::ResultTooLarge</CODE></a>
176            </th>
177<td>Indicates that one or more of the arguments had data that exceeded the maximum size. This occurs for functions that send data.</td>
178          </tr>
179          <tr>
180            <th>
181<a href="../../../nn/uds/CTR/ResultNotAuthorized/Overview.html"><CODE>nn::uds::CTR::ResultNotAuthorized</CODE></a>
182            </th>
183<td>Indicates that one or more of the arguments contain a value that is only permitted in special cases.</td>
184          </tr>
185          <tr>
186            <th>
187<a href="../../../nn/uds/CTR/ResultMiscellaneousSystemError/Overview.html"><CODE>nn::uds::CTR::ResultMiscellaneousSystemError</CODE></a>
188            </th>
189<td>A temporary failure resulting from something on the system side. Normally, if you retry with the same arguments, the function will succeed.</td>
190          </tr>
191          <tr>
192            <th>
193<a href="../../../nn/uds/CTR/ResultNotImplemented/Overview.html"><CODE>nn::uds::CTR::ResultNotImplemented</CODE></a>
194            </th>
195<td>Indicates that although a function has been prepared, its operation has not yet been implemented.</td>
196          </tr>
197          <tr>
198            <th>
199<a href="../../../nn/uds/CTR/ResultMalformedData/Overview.html"><CODE>nn::uds::CTR::ResultMalformedData</CODE></a>
200            </th>
201<td>Indicates that the data is not appropriate and that there is a possibility that the received data may have been tampered with.</td>
202          </tr> </table>
203      </div>
204    </a> <a name="struct" id="struct">
205<h2>Structures</h2>
206      <div class="section">
207        <table class="members">
208          <tr>
209            <th>
210<a href="../../../nn/uds/CTR/ConnectionStatus/Overview.html"><CODE>nn::uds::CTR::ConnectionStatus</CODE></a>
211            </th>
212<td>Structure indicating the UDS connection status.</td>
213          </tr>
214          <tr>
215            <th>
216<a href="../../../nn/uds/CTR/ScrambledLocalFriendCode/Overview.html"><CODE>nn::uds::CTR::ScrambledLocalFriendCode</CODE></a>
217            </th>
218<td>This structure stores information that can be converted to a local friend code using the <a href="../../../nn/friends/Overview.html">friends</a> library.</td>
219          </tr>
220          <tr>
221            <th>
222<a href="../../../nn/uds/CTR/NodeInformation/Overview.html"><CODE>nn::uds::CTR::NodeInformation</CODE></a>
223            </th>
224<td>Structure that stores user information about nodes connected to the network.</td>
225          </tr>
226          <tr>
227            <th>
228<a href="../../../nn/uds/CTR/EndpointDescriptor/Overview.html"><CODE>nn::uds::CTR::EndpointDescriptor</CODE></a>
229            </th>
230<td>Endpoint descriptor. This corresponds to a socket descriptor.</td>
231          </tr> </table>
232      </div>
233    </a> <a name="enum" id="enum">
234<h2>Enumerated Types</h2>
235      <div class="section">
236        <table class="members">
237          <tr>
238            <td width="100"> </td>
239            <th>
240<a href="../../../nn/uds/CTR/State.html"><CODE>State</CODE></a>
241            </th>
242<td>Enumerated type representing UDS states.</td>
243          </tr>
244          <tr>
245            <td width="100"> </td>
246            <th>
247<a href="../../../nn/uds/CTR/DisconnectReason.html"><CODE>DisconnectReason</CODE></a>
248            </th>
249<td>Enumerated type representing the reasons for disconnection.</td>
250          </tr>
251          <tr>
252            <td width="100"> </td>
253            <th>
254<a href="../../../nn/uds/CTR/ConnectType.html"><CODE>ConnectType</CODE></a>
255            </th>
256<td>Enumerated type that represents modes used during connection to the network.</td>
257          </tr>
258          <tr>
259            <td width="100"> </td>
260            <th>
261<a href="../../../nn/uds/CTR/PowerSaveMode.html"><CODE>PowerSaveMode</CODE></a>
262            </th>
263<td>Enumerated type representing the network's power-saving modes.</td>
264          </tr>
265          <tr>
266            <td width="100"> </td>
267            <th>
268<a href="../../../nn/uds/CTR/LinkLevel.html"><CODE>LinkLevel</CODE></a>
269            </th>
270<td>Enumerated type that represents the communication quality (link level).</td>
271          </tr> </table>
272      </div>
273    </a> <a name="constant" id="constant">
274<h2>Constants</h2>
275      <div class="section">
276        <table class="members">
277          <tr>
278<th class="category" colspan="3">Transmission Data Sizes</th>
279          </tr>
280          <tr>
281            <td width="100"> </td>
282            <th>
283<span class="argument"><a href="../../../nn/uds/CTR/NET_DESC_APPDATA_SIZE_MAX.html"><CODE>NET_DESC_APPDATA_SIZE_MAX</CODE></a></span>
284            </th>
285<td>Maximum size of optional data that can be set for the beacon.</td>
286          </tr>
287          <tr>
288            <td width="100"> </td>
289            <th>
290<span class="argument"><a href="../../../nn/uds/CTR/UDS_PACKET_PAYLOAD_MAX_SIZE.html"><CODE>UDS_PACKET_PAYLOAD_MAX_SIZE</CODE></a></span>
291            </th>
292<td>Maximum size of the data that can be sent in a single call to <a href="../../../nn/uds/CTR/SendTo.html"><CODE>nn::uds::CTR::SendTo</CODE></a>.</td>
293          </tr>
294          <tr>
295            <td width="100"> </td>
296            <th>
297<span class="argument"><a href="../../../nn/uds/CTR/ATTACH_BUFFER_SIZE_MIN.html"><CODE>ATTACH_BUFFER_SIZE_MIN</CODE></a></span>
298            </th>
299<td>Minimum size of the receive buffer specified in a call to the <a href="../../../nn/uds/CTR/Attach.html"><CODE>Attach</CODE></a> function. This value is the sum of the <CODE>UDS_PACKET_PAYLOAD_MAX_SIZE</CODE> and the system management region.</td>
300          </tr>
301          <tr>
302            <td width="100"> </td>
303            <th>
304<span class="argument"><a href="../../../nn/uds/CTR/ATTACH_BUFFER_SIZE_DEFAULT.html"><CODE>ATTACH_BUFFER_SIZE_DEFAULT</CODE></a></span>
305            </th>
306<td>Default size of the receive buffer specified in a call to the <a href="../../../nn/uds/CTR/Attach.html"><CODE>Attach</CODE></a> function.</td>
307          </tr>
308          <tr>
309<th class="category" colspan="3">Passphrase String Length</th>
310          </tr>
311          <tr>
312            <td width="100"> </td>
313            <th>
314<span class="argument"><a href="../../../nn/uds/CTR/UDS_PASSPHRASE_LENGTH_MIN.html"><CODE>UDS_PASSPHRASE_LENGTH_MIN</CODE></a></span>
315            </th>
316<td>Minimum size of the passphrase for generating the encrypted key used in communication.</td>
317          </tr>
318          <tr>
319            <td width="100"> </td>
320            <th>
321<span class="argument"><a href="../../../nn/uds/CTR/UDS_PASSPHRASE_LENGTH_MAX.html"><CODE>UDS_PASSPHRASE_LENGTH_MAX</CODE></a></span>
322            </th>
323<td>Maximum size of the passphrase for generating the encrypted key used in communication.</td>
324          </tr>
325          <tr>
326<th class="category" colspan="3">Local Communication ID</th>
327          </tr>
328          <tr>
329            <td width="100"> </td>
330            <th>
331<span class="argument"><a href="../../../nn/uds/CTR/TEST_UNIQUE_ID_MASK.html"><CODE>TEST_UNIQUE_ID_MASK</CODE></a></span>
332            </th>
333<td>For a test program, experimental project, or at any other time that an application does not have a unique ID assigned to it, you can use a value between <CODE>0xFFF00</CODE> and <CODE>0xFFFFF</CODE> as a test ID. These values are also used by SDK samples.</td>
334          </tr>
335          <tr>
336<th class="category" colspan="3">Send/Receive Options</th>
337          </tr>
338          <tr>
339            <td width="100"> </td>
340            <th>
341<span class="argument"><a href="../../../nn/uds/CTR/NO_WAIT.html"><CODE>NO_WAIT</CODE></a></span>
342            </th>
343<td>If this constant is specified as an argument to the <a href="../../../nn/uds/CTR/SendTo.html"><CODE>SendTo</CODE></a> function, wireless transmission occurs immediately without buffering within the UDS library. <br />If this constant is specified as an argument to either the <a href="../../../nn/uds/CTR/Receive.html"><CODE>Receive</CODE></a> or <a href="../../../nn/uds/CTR/ReceiveFrom.html"><CODE>ReceiveFrom</CODE></a> functions, the wireless transmission ends immediately, even if no data has been received.</td>
344          </tr>
345          <tr>
346            <td width="100"> </td>
347            <th>
348<span class="argument"><a href="../../../nn/uds/CTR/FORCE_DIRECT_BC.html"><CODE>FORCE_DIRECT_BC</CODE></a></span>
349            </th>
350<td>When <CODE><A>SendTo</A></CODE> has been specified, sends using Direct Broadcast without asking for a recipient. Among clients, Unicast communication takes place without the use of a master. As a result you can have low latency communication, but the hidden node problem arises.</td>
351          </tr>
352          <tr>
353            <td width="100"> </td>
354            <th>
355<span class="argument"><a href="../../../nn/uds/CTR/FORCE_UNICAST.html"><CODE>FORCE_UNICAST</CODE></a></span>
356            </th>
357<td>When <CODE><A>SendTo</A></CODE> has been specified, the client sends a packet always via a master. There is no need to consider the hidden node problem, but the latency of the client's send becomes higher.</td>
358          </tr>
359          <tr>
360<th class="category" colspan="3">Other</th>
361          </tr>
362          <tr>
363            <td width="100"> </td>
364            <th>
365<span class="argument"><a href="../../../nn/uds/CTR/BROADCAST_NODE_ID.html"><CODE>BROADCAST_NODE_ID</CODE></a></span>
366            </th>
367<td>Node ID indicating the broadcast address for the network. Even spectators can receive data sent to <CODE>BROADCAST_NODE_ID</CODE>.</td>
368          </tr>
369          <tr>
370            <td width="100"> </td>
371            <th>
372<span class="argument"><a href="../../../nn/uds/CTR/NODE_MAX.html"><CODE>NODE_MAX</CODE></a></span>
373            </th>
374<td>Maximum value for the maximum number of network connections. In the future, we plan to support communication for 16 devices, but as of CTR-SDK 0.14 we cannot confirm sufficient operations with that many devices, so communications with 13 or more devices exceeds the guaranteed range of operations.</td>
375          </tr>
376          <tr>
377            <td width="100"> </td>
378            <th>
379<span class="argument"><a href="../../../nn/uds/CTR/ENDPOINT_MAX.html"><CODE>ENDPOINT_MAX</CODE></a></span>
380            </th>
381<td>The maximum number of endpoints that can be created. This value is subject to change.</td>
382          </tr>
383          <tr>
384            <td width="100">
385<span class="static_style" title="static">S</span>
386            </td>
387            <th>
388<span class="argument"><a href="../../../nn/uds/CTR/SCRAMBLED_LOCAL_FRINED_CODE_SIZE.html"><CODE>SCRAMBLED_LOCAL_FRIEND_CODE_SIZE</CODE></a></span>
389            </th>
390<td>The byte length of <CODE><a href="../../../nn/uds/CTR/ScrambledLocalFriendCode/Overview.html">ScrambledLocalFriendCode</a></CODE>.</td>
391          </tr> </table>
392      </div>
393    </a> <a name="function" id="function">
394<h2>Functions</h2>
395      <div class="section">
396        <table class="members">
397          <tr>
398<th class="category" colspan="3">Initialization & Shutdown</th>
399          </tr>
400          <tr>
401            <td width="100">  </td>
402            <th>
403<a href="../../../nn/uds/CTR/Initialize.html"><CODE>Initialize</CODE></a>
404            </th>
405<td>Initializes the UDS library. Initialization fails if any other communication features are already in use.</td>
406          </tr>
407          <tr>
408            <td width="100">  </td>
409            <th>
410<a href="../../../nn/uds/CTR/Finalize.html"><CODE>Finalize</CODE></a>
411            </th>
412<td>Finalizes the UDS library. After executing, other communication features become usable.</td>
413          </tr>
414          <tr>
415<th class="category" colspan="3">Networks (Creating, Destroying, Connecting, and Disconnecting)</th>
416          </tr>
417          <tr>
418            <td width="100">  </td>
419            <th>
420<a href="../../../nn/uds/CTR/CreateLocalCommunicationId.html"><CODE>CreateLocalCommunicationId</CODE></a>
421            </th>
422<td>A local communication ID is generated from a unique ID.</td>
423          </tr>
424          <tr>
425            <td width="100">  </td>
426            <th>
427<a href="../../../nn/uds/CTR/CreateNetwork.html"><CODE>CreateNetwork</CODE></a>
428            </th>
429<td>Creates a new network.</td>
430          </tr>
431          <tr>
432            <td width="100">  </td>
433            <th>
434<a href="../../../nn/uds/CTR/Scan.html"><CODE>Scan</CODE></a>
435            </th>
436<td>Scans for nearby networks.</td>
437          </tr>
438          <tr>
439            <td width="100">  </td>
440            <th>
441<a href="../../../nn/uds/CTR/ConnectNetwork.html"><CODE>ConnectNetwork</CODE></a>
442            </th>
443<td>Connects to an existing network.</td>
444          </tr>
445          <tr>
446            <td width="100">  </td>
447            <th>
448<a href="../../../nn/uds/CTR/EjectClient.html"><CODE>EjectClient</CODE></a>
449            </th>
450<td>Kicks the specified node off of the network. Only the master can run this function.</td>
451          </tr>
452          <tr>
453            <td width="100">  </td>
454            <th>
455<a href="../../../nn/uds/CTR/DisallowToConnect.html"><CODE>DisallowToConnect</CODE></a>
456            </th>
457<td>Disallows client nodes to connect to the network. Does not effect clients currently connected.</td>
458          </tr>
459          <tr>
460            <td width="100">  </td>
461            <th>
462<a href="../../../nn/uds/CTR/AllowToConnect.html"><CODE>AllowToConnect</CODE></a>
463            </th>
464<td>Allows client nodes to connect to the network.</td>
465          </tr>
466          <tr>
467            <td width="100">  </td>
468            <th>
469<a href="../../../nn/uds/CTR/EjectSpectator.html"><CODE>EjectSpectator</CODE></a>
470            </th>
471<td>Kicks all the connected spectators off of the network.</td>
472          </tr>
473          <tr>
474            <td width="100">  </td>
475            <th>
476<a href="../../../nn/uds/CTR/AllowToSpectate.html"><CODE>AllowToSpectate</CODE></a>
477            </th>
478<td>Allows Spectator nodes to connect to the network.</td>
479          </tr>
480          <tr>
481            <td width="100">  </td>
482            <th>
483<a href="../../../nn/uds/CTR/DestroyNetwork.html"><CODE>DestroyNetwork</CODE></a>
484            </th>
485<td>Destroys the network.</td>
486          </tr>
487          <tr>
488            <td width="100">  </td>
489            <th>
490<a href="../../../nn/uds/CTR/DisconnectNetwork.html"><CODE>DisconnectNetwork</CODE></a>
491            </th>
492<td>Disconnects a given node from the network to which it is currently connected.</td>
493          </tr>
494          <tr>
495<th class="category" colspan="3">Sending and Receiving Data</th>
496          </tr>
497          <tr>
498            <td width="100">  </td>
499            <th>
500<a href="../../../nn/uds/CTR/CreateEndpoint.html"><CODE>CreateEndpoint</CODE></a>
501            </th>
502<td>Creates a network endpoint and returns the corresponding descriptor.</td>
503          </tr>
504          <tr>
505            <td width="100">  </td>
506            <th>
507<a href="../../../nn/uds/CTR/SetMaxSendDelay.html"><CODE>SetMaxSendDelay</CODE></a>
508            </th>
509<td>Specifies the maximum send delay time.</td>
510          </tr>
511          <tr>
512            <td width="100">  </td>
513            <th>
514<a href="../../../nn/uds/CTR/SendTo.html"><CODE>SendTo</CODE></a>
515            </th>
516<td>Sends data to the specified port on the specified partner's system.</td>
517          </tr>
518          <tr>
519            <td width="100">  </td>
520            <th>
521<a href="../../../nn/uds/CTR/Attach.html"><CODE>Attach</CODE></a>
522            </th>
523<td>Makes the endpoint into a packet-receivable state.</td>
524          </tr>
525          <tr>
526            <td width="100">  </td>
527            <th>
528<a href="../../../nn/uds/CTR/Receive.html"><CODE>Receive</CODE></a>
529            </th>
530<td>Receives data. (There is no way to obtain the address of the sender.)</td>
531          </tr>
532          <tr>
533            <td width="100">  </td>
534            <th>
535<a href="../../../nn/uds/CTR/ReceiveFrom.html"><CODE>ReceiveFrom</CODE></a>
536            </th>
537<td>Receives data.</td>
538          </tr>
539          <tr>
540            <td width="100">  </td>
541            <th>
542<a href="../../../nn/uds/CTR/DestroyEndpoint.html"><CODE>DestroyEndpoint</CODE></a>
543            </th>
544<td>Destroys an endpoint.</td>
545          </tr>
546          <tr>
547<th class="category" colspan="3">Other</th>
548          </tr>
549          <tr>
550            <td width="100">  </td>
551            <th>
552<a href="../../../nn/uds/CTR/GetMacAddress.html"><CODE>GetMacAddress</CODE></a>
553            </th>
554<td>Gets the MAC address of the local host. (Used in debugging)</td>
555          </tr>
556          <tr>
557            <td width="100">  </td>
558            <th>
559<a href="../../../nn/uds/CTR/GetConnectionStatus.html"><CODE>GetConnectionStatus</CODE></a>
560            </th>
561<td>Returns the current connection status.</td>
562          </tr>
563          <tr>
564            <td width="100">  </td>
565            <th>
566<a href="../../../nn/uds/CTR/GetLinkLevel.html"><CODE>GetLinkLevel</CODE></a>
567            </th>
568<td>Gets the current link level.</td>
569          </tr>
570          <tr>
571            <td width="100">  </td>
572            <th>
573<a href="../../../nn/uds/CTR/GetNodeInformation.html"><CODE>GetNodeInformation</CODE></a>
574            </th>
575<td>Gets information about the specified node.</td>
576          </tr>
577          <tr>
578            <td width="100">  </td>
579            <th>
580<a href="../../../nn/uds/CTR/SetPowerSaveMode.html"><CODE>SetPowerSaveMode</CODE></a>
581            </th>
582<td>Changes the power-saving mode. (This has not yet been implemented.)</td>
583          </tr>
584          <tr>
585            <td width="100">  </td>
586            <th>
587<a href="../../../nn/uds/CTR/SetApplicationDataToBeacon.html"><CODE>SetApplicationDataToBeacon</CODE></a>
588            </th>
589<td>Sets optional data in the beacon.</td>
590          </tr>
591          <tr>
592            <td width="100">  </td>
593            <th>
594<a href="../../../nn/uds/CTR/GetApplicationDataFromBeacon.html"><CODE>GetApplicationDataFromBeacon</CODE></a>
595            </th>
596<td>Gets the data set to the beacon.</td>
597          </tr> </table>
598      </div>
599    </a>
600<h2>Revision History</h2>
601    <div class="section">
602      <dl class="history">
603        <dt>2011/01/25</dt>
604<dd>Added description that almost all library functions can block.<br />
605        </dd>
606        <dt>2010/12/15</dt>
607<dd>Added information to <B>Description</B> and <B>Notes</B>.
608        </dd>
609        <dt>2010/10/22</dt>
610<dd>Updated the members of the <CODE>nn::uds::NodeInformation</CODE> structure.
611        </dd>
612        <dt>2010/10/15</dt>
613<dd>Added as a reference to the functions that return <CODE>nn::Result</CODE> information on what values are returned. Deleted the not-yet-implemented function, <CODE>SetNetworkAttribute</CODE>. Added a new function, <CODE>SetMaxSendDelay</CODE>, which configures the maximum send delay time. Added a new <CODE>ResultMalformedData</CODE> error. Added a new <CODE>ResultMiscellaneousSystemError</CODE> error. Added a function to cut off a connection to a network, <CODE>DisallowToConnect</CODE>, and a function to re-allow a connection, <CODE>AllowToConnect</CODE>.
614        </dd>
615        <dt>2010/06/14</dt>
616<dd>Initial version.<br />
617        </dd>
618      </dl>
619    </div>
620  <hr><p>CONFIDENTIAL</p></body>
621</html>