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<title>Attach</title>
8  </head>
9  <body>
10<h1><CODE><a href="../../../nn/Overview.html">nn</a>::<a href="../../../nn/uds/Overview.html">uds</a>::<a href="../../../nn/uds/CTR/Overview.html">CTR</a>::Attach</CODE> Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">
14<a href="../../../nn/Result/Overview.html">nn::Result</a> Attach(
15     <a href="../../../nn/uds/CTR/EndpointDescriptor/Overview.html">EndpointDescriptor</a> * pEndpointDesc,
16     <a href="../../../nn_types/u16.html">u16</a> srcNodeId,
17     <a href="../../../nn_types/u8.html">u8</a> port,
18     size_t receiveBufferSize = <a href="../../../nn/uds/CTR/ATTACH_BUFFER_SIZE_DEFAULT.html">ATTACH_BUFFER_SIZE_DEFAULT</a>
19);
20</pre>
21    </div>
22<h2>Parameters</h2>
23    <div class="section">
24      <table class="arguments">
25        <thead>
26          <tr>
27            <td width="15" />
28<th>Name</th>
29<td>Description</td>
30          </tr>
31        </thead>
32        <tr>
33<td>in</td>
34<th>pEndpointDesc</th>
35<td>Descriptor indicating the endpoint to use.</td>
36        </tr>
37        <tr>
38<td>in</td>
39<th>srcNodeId</th>
40<td>ID of node to attach. When <CODE><a href="../../../nn/uds/CTR/BROADCAST_NODE_ID.html">BROADCAST_NODE_ID</a></CODE> is specified, all nodes will be attached.</td>
41        </tr>
42        <tr>
43<td>in</td>
44<th>port</th>
45<td>Port number to attach. Port number <CODE>0x00</CODE> is reserved by the system and cannot be used.</td>
46        </tr>
47        <tr>
48<td>in</td>
49<th>receiveBufferSize</th>
50<td>Size of the receive buffer to allocate. This is allocated from the memory block allocated by the <a href="../../../nn/uds/CTR/Initialize.html"><CODE>Initialize</CODE></a> function, so take care that the total size of all receive buffers does not exceed the size of this allocated memory block. You must specify at least <a href="../../../nn/uds/CTR/ATTACH_BUFFER_SIZE_MIN.html"><CODE>ATTACH_BUFFER_SIZE_MIN</CODE></a> bytes. By default, allocate <a href="../../../nn/uds/CTR/ATTACH_BUFFER_SIZE_DEFAULT.html"><CODE>ATTACH_BUFFER_SIZE_DEFAULT</CODE></a> bytes. When specifying the data size, choosing a multiple of 32 will yield the maximum efficiency because memory is allocated in 32-byte chunks.</td>
51        </tr> </table>
52    </div>
53<h2>Return Values</h2>
54<div class="section">Returns the function's execution result. Returns one of the <a href="../../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below. <br />
55      <table class="arguments">
56        <thead>
57          <tr>
58<th>Value</th>
59<td>Description</td>
60          </tr>
61        </thead>
62        <tr>
63<th><CODE>Result::IsSuccess</CODE></th>
64<td>Process was successful.</td>
65        </tr>
66        <tr>
67<th><CODE>ResultNotInitialized</CODE></th>
68<td>The library is not initialized. Execute the <CODE><a href="../../../nn/uds/CTR/Initialize.html">Initialize</a></CODE> function.</td>
69        </tr>
70        <tr>
71<th><CODE>ResultInvalidState</CODE></th>
72<td>Not in an executable state.</td>
73        </tr>
74        <tr>
75<th><CODE>ResultOutOfResource</CODE></th>
76<td>This is returned when the receive buffer specified by the <CODE><a href="../../../nn/uds/CTR/Initialize.html">Initialize</a></CODE> function is insufficient and when there are insufficient system resources.</td>
77        </tr>
78        <tr>
79<th><CODE>ResultOutOfRange</CODE></th>
80<td>The specified argument was not in a specifiable range. It is possible it will succeed if you re-execute with an appropriate value for the argument.</td>
81        </tr>
82        <tr>
83<th><CODE>ResultWirelessOff</CODE></th>
84<td>Entered wireless-disabled mode. Re-initialization is required.</td>
85        </tr>
86        <tr>
87<th>A value other than the above</th>
88<td>Failed for reasons other than those given above.</td>
89        </tr>
90      </table> </div>
91<h2>Description</h2>
92    <div class="section">
93<p>Makes the endpoint into a packet-receivable state.</p><p>Attaches the specified port and node ID to the endpoint. The system creates a receive buffer, and then becomes able to receive sent packets at a subsequently specified port.<BR><BR> This function is thread-safe.</p><!-- write here --></div>
94<h2>Revision History</h2>
95    <div class="section">
96      <dl class="history">
97        <dt>2011/09/07</dt>
98<dd>Standardized notation for wireless-disabled mode.<br />
99        </dd>
100        <dt>2011/03/08</dt>
101<dd>Added a link to <CODE>BROADCAST_NODE_ID</CODE> in the description of the <SPAN class="argument">destNodeId</SPAN> argument. Added a link to <CODE>Initialize</CODE> in <B>Return Values</B>.<br />
102        </dd>
103        <dt>2010/10/15</dt>
104<dd>Expanded the information on the return values.<br />
105        </dd>
106        <dt>2010/06/14</dt>
107<dd>Initial version.<br />
108        </dd>
109      </dl>
110    </div>
111  <hr><p>CONFIDENTIAL</p></body>
112</html>