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::socket</title>
51  </head>
52  <body>
53<h1><CODE><a href="../../nn/Overview.html">nn</a>::socket</CODE> Namespace</h1>
54<h2>Description</h2>
55    <div class="section">
56<p>Namespace for the socket API.</p><p>This library is provided for initializing and finalizing sockets when NEX features are used. Contact Nintendo if you want to use this library for direct communication.</p><!-- write here --></div>
57    <a name="struct" id="struct">
58<h2>Structures</h2>
59      <div class="section">
60        <table class="members">
61          <tr>
62            <th>
63<a href="../../nn/socket/SockAddrIn/Overview.html"><CODE>nn::socket::SockAddrIn</CODE></a>
64            </th>
65<td>An IPv4 socket structure.</td>
66          </tr>
67          <tr>
68            <th>
69<a href="../../nn/socket/SockAddr/Overview.html"><CODE>nn::socket::SockAddr</CODE></a>
70            </th>
71<td>A socket structure.</td>
72          </tr>
73          <tr>
74            <th>
75<a href="../../nn/socket/Linger/Overview.html"><CODE>nn::socket::Linger</CODE></a>
76            </th>
77<td>A structure used with <CODE>SO_LINGER</CODE> in the <CODE>GetSockOpt</CODE> and <CODE>SetSockOpt</CODE> functions.</td>
78          </tr>
79          <tr>
80            <th>
81<a href="../../nn/socket/IpMreq/Overview.html"><CODE>nn::socket::IpMreq</CODE></a>
82            </th>
83<td>A structure used when using <CODE>IP_ADD_MEMBERSHIP</CODE> and <CODE>IP_DROP_MEMBERSHIP</CODE> with the <CODE>GetSockOpt</CODE> and <CODE>SetSockOpt</CODE> functions.</td>
84          </tr>
85          <tr>
86            <th>
87<a href="../../nn/socket/PollFd/Overview.html"><CODE>nn::socket::PollFd</CODE></a>
88            </th>
89<td>A structure used with the <CODE>Poll</CODE> function.</td>
90          </tr>
91          <tr>
92            <th>
93<a href="../../nn/socket/AddrInfo/Overview.html"><CODE>nn::socket::AddrInfo</CODE></a>
94            </th>
95<td>A structure used with the <CODE>GetAddrInfo</CODE> function.</td>
96          </tr>
97          <tr>
98            <th>
99<a href="../../nn/socket/HostEnt/Overview.html"><CODE>nn::socket::HostEnt</CODE></a>
100            </th>
101<td>A structure used with the <CODE>GetHostByAddr</CODE> function and <CODE>GetHostByName</CODE> function.</td>
102          </tr>
103          <tr>
104            <th>
105<a href="../../nn/socket/DnsAddr/Overview.html"><CODE>nn::socket::DnsAddr</CODE></a>
106            </th>
107<td>A structure for DNS server addresses.</td>
108          </tr> </table>
109      </div>
110    </a> <a name="enum" id="enum">
111<h2>Enumerated Types</h2>
112      <div class="section">
113        <table class="members">
114          <tr>
115            <td width="100"> </td>
116            <th>
117<a href="../../nn/socket/ProtocolFamily.html"><CODE>ProtocolFamily</CODE></a>
118            </th>
119<td>An enumerated type representing protocol families.</td>
120          </tr>
121          <tr>
122            <td width="100"> </td>
123            <th>
124<a href="../../nn/socket/AddressFamily.html"><CODE>AddressFamily</CODE></a>
125            </th>
126<td>An enumerated type representing address families.</td>
127          </tr>
128          <tr>
129            <td width="100"> </td>
130            <th>
131<a href="../../nn/socket/SocketType.html"><CODE>SocketType</CODE></a>
132            </th>
133<td>An enumerated type representing socket types.</td>
134          </tr>
135          <tr>
136            <td width="100"> </td>
137            <th>
138<a href="../../nn/socket/MessageFlag.html"><CODE>MessageFlag</CODE></a>
139            </th>
140<td>Flags given to functions such as <CODE>RecvFrom</CODE> and <CODE>SendTo</CODE>.</td>
141          </tr>
142          <tr>
143            <td width="100"> </td>
144            <th>
145<a href="../../nn/socket/PollType.html"><CODE>PollType</CODE></a>
146            </th>
147<td>Flags given to the <CODE>Poll</CODE> function.</td>
148          </tr>
149          <tr>
150            <td width="100"> </td>
151            <th>
152<a href="../../nn/socket/SocketLevel.html"><CODE>SocketLevel</CODE></a>
153            </th>
154<td>Option levels given to functions such as <CODE>GetSockOpt</CODE> and <CODE>SetSockOpt</CODE>.</td>
155          </tr>
156          <tr>
157            <td width="100"> </td>
158            <th>
159<a href="../../nn/socket/SocketOptionType.html"><CODE>SocketOptionType</CODE></a>
160            </th>
161<td>Option numbers given to the <CODE>GetSockOpt</CODE> and <CODE>SetSockOpt</CODE> functions.</td>
162          </tr>
163          <tr>
164            <td width="100"> </td>
165            <th>
166<a href="../../nn/socket/ShutdownType.html"><CODE>ShutdownType</CODE></a>
167            </th>
168<td>Flags given to the <CODE>Shutdown</CODE> function.</td>
169          </tr>
170          <tr>
171            <td width="100"> </td>
172            <th>
173<a href="../../nn/socket/FcntlFlag.html"><CODE>FcntlFlag</CODE></a>
174            </th>
175<td>Flags given to the <CODE>Fcntl</CODE> function.</td>
176          </tr>
177          <tr>
178            <td width="100"> </td>
179            <th>
180<a href="../../nn/socket/FcntlOperation.html"><CODE>FcntlOperation</CODE></a>
181            </th>
182<td>Mode values given to the <CODE>Fcntl</CODE> function.</td>
183          </tr>
184          <tr>
185            <td width="100"> </td>
186            <th>
187<a href="../../nn/socket/AddrInfoType.html"><CODE>AddrInfoType</CODE></a>
188            </th>
189<td>Flags given to the <CODE>GetAddrInfo</CODE> function.</td>
190          </tr>
191          <tr>
192            <td width="100"> </td>
193            <th>
194<a href="../../nn/socket/NameInfoType.html"><CODE>NameInfoType</CODE></a>
195            </th>
196<td>Flags given to the <CODE>GetNameInfo</CODE> function.</td>
197          </tr>
198          <tr>
199            <td width="100"> </td>
200            <th>
201<a href="../../nn/socket/AddrInfoError.html"><CODE>AddrInfoError</CODE></a>
202            </th>
203<td>Error values returned by the <CODE>GetAddrInfo</CODE> and <CODE>GetNameInfo</CODE> functions.</td>
204          </tr>
205          <tr>
206            <td width="100"> </td>
207            <th>
208<a href="../../nn/socket/SocketError.html"><CODE>SocketError</CODE></a>
209            </th>
210<td>Error values shared by socket functions. Errors without descriptions are used internally and are never returned by the socket API.</td>
211          </tr> </table>
212      </div>
213    </a> <a name="function" id="function">
214<h2>Functions</h2>
215      <div class="section">
216        <table class="members">
217          <tr>
218<th class="category" colspan="3">Initialization/Termination</th>
219          </tr>
220          <tr>
221            <td width="100">  </td>
222            <th>
223<a href="../../nn/socket/Initialize.html"><CODE>Initialize</CODE></a>
224            </th>
225<td>Initializes the socket library, allowing socket API functions to be called.</td>
226          </tr>
227          <tr>
228            <td width="100">  </td>
229            <th>
230<a href="../../nn/socket/GetRequiredMemorySize.html"><CODE>GetRequiredMemorySize</CODE></a>
231            </th>
232<td>Gets the minimum amount of working memory required to initialize the socket library.</td>
233          </tr>
234          <tr>
235            <td width="100">  </td>
236            <th>
237<a href="../../nn/socket/Finalize.html"><CODE>Finalize</CODE></a>
238            </th>
239<td>Finalizes the socket library and releases any resources used by it.</td>
240          </tr>
241          <tr>
242<th class="category" colspan="3">Utilities</th>
243          </tr>
244          <tr>
245            <td width="100">  </td>
246            <th>
247<a href="../../nn/socket/GetDefaultGateway.html"><CODE>GetDefaultGateway</CODE></a>
248            </th>
249<td>Gets the address of the default gateway.</td>
250          </tr>
251          <tr>
252            <td width="100">  </td>
253            <th>
254<a href="../../nn/socket/GetPrimaryAddress.html"><CODE>GetPrimaryAddress</CODE></a>
255            </th>
256<td>Gets the IP address and netmask of the local host.</td>
257          </tr>
258          <tr>
259            <td width="100">  </td>
260            <th>
261<a href="../../nn/socket/GetResolver.html"><CODE>GetResolver</CODE></a>
262            </th>
263<td>Gets the address of the DNS server to use for name resolution.</td>
264          </tr>
265          <tr>
266            <td width="100">  </td>
267            <th>
268<a href="../../nn/socket/GetMacAddress.html"><CODE>GetMacAddress</CODE></a>
269            </th>
270<td>Gets the MAC address.</td>
271          </tr>
272          <tr>
273            <td width="100">  </td>
274            <th>
275<a href="../../nn/socket/DumpRoutingTable.html"><CODE>DumpRoutingTable</CODE></a>
276            </th>
277<td>Outputs the routing table to the console.</td>
278          </tr> </table>
279      </div>
280    </a>
281<h2>Revision History</h2>
282    <div class="section">
283      <dl class="history">
284        <dt>2010/06/14</dt>
285<dd>Initial version.<br />
286        </dd>
287      </dl>
288    </div>
289  <hr><p>CONFIDENTIAL</p></body>
290</html>