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::http</title> 51 </head> 52 <body> 53<h1><CODE>nn::http</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<p>Namespace for the HTTP communication API.</p><p><B>Note:</B> This library is provided for debugging purposes. If you intend to include it in your retail product, contact Nintendo at support@noa.com.<br /></p><!-- write here --></div> 57 <a name="class" id="class"> 58<h2>Classes</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62<th class="category" colspan="2">Result</th> 63 </tr> 64 <tr> 65 <th> 66<a href="../../nn/http/ResultInvalidStatusErr/Overview.html"><CODE>nn::http::ResultInvalidStatusErr</CODE></a> 67 </th> 68<td>Indicates invalid status.</td> 69 </tr> 70 <tr> 71 <th> 72<a href="../../nn/http/ResultInvalidParamErr/Overview.html"><CODE>nn::http::ResultInvalidParamErr</CODE></a> 73 </th> 74<td>Indicates invalid parameter.</td> 75 </tr> 76 <tr> 77 <th> 78<a href="../../nn/http/ResultOutOfMemoryErr/Overview.html"><CODE>nn::http::ResultOutOfMemoryErr</CODE></a> 79 </th> 80<td>Indicates dynamic memory allocation failure.</td> 81 </tr> 82 <tr> 83 <th> 84<a href="../../nn/http/ResultCreateEventErr/Overview.html"><CODE>nn::http::ResultCreateEventErr</CODE></a> 85 </th> 86<td>Indicates failure to create an event.</td> 87 </tr> 88 <tr> 89 <th> 90<a href="../../nn/http/ResultCreateMutexErr/Overview.html"><CODE>nn::http::ResultCreateMutexErr</CODE></a> 91 </th> 92<td>Indicates failure to create a mutex.</td> 93 </tr> 94 <tr> 95 <th> 96<a href="../../nn/http/ResultCreateQueueErr/Overview.html"><CODE>nn::http::ResultCreateQueueErr</CODE></a> 97 </th> 98<td>Indicates failure to create a message queue.</td> 99 </tr> 100 <tr> 101 <th> 102<a href="../../nn/http/ResultCreateThreadErr/Overview.html"><CODE>nn::http::ResultCreateThreadErr</CODE></a> 103 </th> 104<td>Indicates failure to create a thread.</td> 105 </tr> 106 <tr> 107 <th> 108<a href="../../nn/http/ResultNotConnectedErr/Overview.html"><CODE>nn::http::ResultNotConnectedErr</CODE></a> 109 </th> 110<td>Indicates that the connection is not initialized.</td> 111 </tr> 112 <tr> 113 <th> 114<a href="../../nn/http/ResultAlreadyAssignHostErr/Overview.html"><CODE>nn::http::ResultAlreadyAssignHostErr</CODE></a> 115 </th> 116<td>Indicates that the remote host has already been allocated.</td> 117 </tr> 118 <tr> 119 <th> 120<a href="../../nn/http/ResultSessionErr/Overview.html"><CODE>nn::http::ResultSessionErr</CODE></a> 121 </th> 122<td>Indicates an invalid IPC session.</td> 123 </tr> 124 <tr> 125 <th> 126<a href="../../nn/http/ResultClientProcessMaxErr/Overview.html"><CODE>nn::http::ResultClientProcessMaxErr</CODE></a> 127 </th> 128<td>Indicates that the maximum number of simultaneous client processes are already being used.</td> 129 </tr> 130 <tr> 131 <th> 132<a href="../../nn/http/ResultIpcSessionMaxErr/Overview.html"><CODE>nn::http::ResultIpcSessionMaxErr</CODE></a> 133 </th> 134<td>Indicates that the maximum number of simultaneous IPC sessions are already connected.</td> 135 </tr> 136 <tr> 137 <th> 138<a href="../../nn/http/ResultAlreadyInitializedErr/Overview.html"><CODE>nn::http::ResultAlreadyInitializedErr</CODE></a> 139 </th> 140<td>Indicates that a library is already initialized.</td> 141 </tr> 142 <tr> 143 <th> 144<a href="../../nn/http/ResultNotInitializedErr/Overview.html"><CODE>nn::http::ResultNotInitializedErr</CODE></a> 145 </th> 146<td>Indicates that a library is not initialized.</td> 147 </tr> 148 <tr> 149 <th> 150<a href="../../nn/http/ResultMessageSendToListenThreadErr/Overview.html"><CODE>nn::http::ResultMessageSendToListenThreadErr</CODE></a> 151 </th> 152<td>Indicates a listener thread message queue sending failure.</td> 153 </tr> 154 <tr> 155 <th> 156<a href="../../nn/http/ResultMessageRecvInListenThreadErr/Overview.html"><CODE>nn::http::ResultMessageRecvInListenThreadErr</CODE></a> 157 </th> 158<td>Indicates a listener thread message queue reception failure.</td> 159 </tr> 160 <tr> 161 <th> 162<a href="../../nn/http/ResultMessageRecvInCommunicationThreadErr/Overview.html"><CODE>nn::http::ResultMessageRecvInCommunicationThreadErr</CODE></a> 163 </th> 164<td>Indicates a communication thread message queue reception failure.</td> 165 </tr> 166 <tr> 167 <th> 168<a href="../../nn/http/ResultConnectionNoMoreErr/Overview.html"><CODE>nn::http::ResultConnectionNoMoreErr</CODE></a> 169 </th> 170<td>Indicates that the maximum number of registerable connection handles has been exceeded.</td> 171 </tr> 172 <tr> 173 <th> 174<a href="../../nn/http/ResultNoSuchConnectionErr/Overview.html"><CODE>nn::http::ResultNoSuchConnectionErr</CODE></a> 175 </th> 176<td>Indicates a request for an operation on a nonexistent connection.</td> 177 </tr> 178 <tr> 179 <th> 180<a href="../../nn/http/ResultConnectionStatusErr/Overview.html"><CODE>nn::http::ResultConnectionStatusErr</CODE></a> 181 </th> 182<td>Indicates an invalid connection status.</td> 183 </tr> 184 <tr> 185 <th> 186<a href="../../nn/http/ResultConnectionAddErr/Overview.html"><CODE>nn::http::ResultConnectionAddErr</CODE></a> 187 </th> 188<td>Indicates a failure to register a connection.</td> 189 </tr> 190 <tr> 191 <th> 192<a href="../../nn/http/ResultConnectionCanceledErr/Overview.html"><CODE>nn::http::ResultConnectionCanceledErr</CODE></a> 193 </th> 194<td>Indicates that the connection was canceled.</td> 195 </tr> 196 <tr> 197 <th> 198<a href="../../nn/http/ResultConnectionHostMaxErr/Overview.html"><CODE>nn::http::ResultConnectionHostMaxErr</CODE></a> 199 </th> 200<td>Indicates that the maximum number of simultaneous connections to the same host has been exceeded.</td> 201 </tr> 202 <tr> 203 <th> 204<a href="../../nn/http/ResultConnectionProcessMaxErr/Overview.html"><CODE>nn::http::ResultConnectionProcessMaxErr</CODE></a> 205 </th> 206<td>Indicates that the maximum number of connections used by one process has been exceeded.</td> 207 </tr> 208 <tr> 209 <th> 210<a href="../../nn/http/ResultRequestUrlErr/Overview.html"><CODE>nn::http::ResultRequestUrlErr</CODE></a> 211 </th> 212<td>Indicates an invalid URL.</td> 213 </tr> 214 <tr> 215 <th> 216<a href="../../nn/http/ResultRequestPortErr/Overview.html"><CODE>nn::http::ResultRequestPortErr</CODE></a> 217 </th> 218<td>Indicates an invalid port on the remote host.</td> 219 </tr> 220 <tr> 221 <th> 222<a href="../../nn/http/ResultRequestUnknownMethodErr/Overview.html"><CODE>nn::http::ResultRequestUnknownMethodErr</CODE></a> 223 </th> 224<td>Indicates an unknown method.</td> 225 </tr> 226 <tr> 227 <th> 228<a href="../../nn/http/ResultRequestHeaderErr/Overview.html"><CODE>nn::http::ResultRequestHeaderErr</CODE></a> 229 </th> 230<td>Indicates an invalid HTTP header.</td> 231 </tr> 232 <tr> 233 <th> 234<a href="../../nn/http/ResultRequestNoNewLineErr/Overview.html"><CODE>nn::http::ResultRequestNoNewLineErr</CODE></a> 235 </th> 236<td>Indicates no newline in an HTTP header.</td> 237 </tr> 238 <tr> 239 <th> 240<a href="../../nn/http/ResultBodyBufErr/Overview.html"><CODE>nn::http::ResultBodyBufErr</CODE></a> 241 </th> 242<td>Indicates an HTTP body receive buffer error.</td> 243 </tr> 244 <tr> 245 <th> 246<a href="../../nn/http/ResultBodyBufShortage/Overview.html"><CODE>nn::http::ResultBodyBufShortage</CODE></a> 247 </th> 248<td>Indicates insufficient space in the HTTP body receive buffer.</td> 249 </tr> 250 <tr> 251 <th> 252<a href="../../nn/http/ResultPostAddedAnotherErr/Overview.html"><CODE>nn::http::ResultPostAddedAnotherErr</CODE></a> 253 </th> 254<td>Indicates a failure to add <CODE>POST</CODE> data.</td> 255 </tr> 256 <tr> 257 <th> 258<a href="../../nn/http/ResultPostBoundaryErr/Overview.html"><CODE>nn::http::ResultPostBoundaryErr</CODE></a> 259 </th> 260<td>Indicates that the <CODE>POST</CODE> data boundary could not be properly set.</td> 261 </tr> 262 <tr> 263 <th> 264<a href="../../nn/http/ResultPostSendErr/Overview.html"><CODE>nn::http::ResultPostSendErr</CODE></a> 265 </th> 266<td>Indicates a <CODE>POST</CODE> request sending failure.</td> 267 </tr> 268 <tr> 269 <th> 270<a href="../../nn/http/ResultPostUnknownEnctypeErr/Overview.html"><CODE>nn::http::ResultPostUnknownEnctypeErr</CODE></a> 271 </th> 272<td>Indicates an unknown encoding for <CODE>POST</CODE> data.</td> 273 </tr> 274 <tr> 275 <th> 276<a href="../../nn/http/ResultPostNoDataErr/Overview.html"><CODE>nn::http::ResultPostNoDataErr</CODE></a> 277 </th> 278<td>Indicates that no settings have been configured for sending <CODE>POST</CODE> data.</td> 279 </tr> 280 <tr> 281 <th> 282<a href="../../nn/http/ResultSslErr/Overview.html"><CODE>nn::http::ResultSslErr</CODE></a> 283 </th> 284<td>Indicates an SSL error.</td> 285 </tr> 286 <tr> 287 <th> 288<a href="../../nn/http/ResultCertExistErr/Overview.html"><CODE>nn::http::ResultCertExistErr</CODE></a> 289 </th> 290<td>Indicates that the SSL certificate is already set (must be deleted before re-registering).</td> 291 </tr> 292 <tr> 293 <th> 294<a href="../../nn/http/ResultNoCaCertStoreErr/Overview.html"><CODE>nn::http::ResultNoCaCertStoreErr</CODE></a> 295 </th> 296<td>Indicates that no such SSL CA certificate store is registered.</td> 297 </tr> 298 <tr> 299 <th> 300<a href="../../nn/http/ResultNoClientCertErr/Overview.html"><CODE>nn::http::ResultNoClientCertErr</CODE></a> 301 </th> 302<td>Indicates that no such SSL client certificate is registered.</td> 303 </tr> 304 <tr> 305 <th> 306<a href="../../nn/http/ResultCaCertStoreMaxErr/Overview.html"><CODE>nn::http::ResultCaCertStoreMaxErr</CODE></a> 307 </th> 308<td>Indicates that the maximum number of simultaneously registerable SSL per-process CA certificate stores is already registered.</td> 309 </tr> 310 <tr> 311 <th> 312<a href="../../nn/http/ResultClientCertMaxErr/Overview.html"><CODE>nn::http::ResultClientCertMaxErr</CODE></a> 313 </th> 314<td>Indicates that the maximum number of simultaneously registerable SSL per-process client certificates is already registered.</td> 315 </tr> 316 <tr> 317 <th> 318<a href="../../nn/http/ResultFailToCreateCertStoreErr/Overview.html"><CODE>nn::http::ResultFailToCreateCertStoreErr</CODE></a> 319 </th> 320<td>Indicates a failure to create an SSL certificate store.</td> 321 </tr> 322 <tr> 323 <th> 324<a href="../../nn/http/ResultFailToCreateClientCertErr/Overview.html"><CODE>nn::http::ResultFailToCreateClientCertErr</CODE></a> 325 </th> 326<td>Indicates a failure to create an SSL client certificate.</td> 327 </tr> 328 <tr> 329 <th> 330<a href="../../nn/http/ResultDnsResolutionErr/Overview.html"><CODE>nn::http::ResultDnsResolutionErr</CODE></a> 331 </th> 332<td>Indicates a DNS name resolution failure.</td> 333 </tr> 334 <tr> 335 <th> 336<a href="../../nn/http/ResultSocketSendErr/Overview.html"><CODE>nn::http::ResultSocketSendErr</CODE></a> 337 </th> 338<td>Indicates a socket data sending error.</td> 339 </tr> 340 <tr> 341 <th> 342<a href="../../nn/http/ResultSocketReceiveErr/Overview.html"><CODE>nn::http::ResultSocketReceiveErr</CODE></a> 343 </th> 344<td>Indicates a socket data reception error.</td> 345 </tr> 346 <tr> 347 <th> 348<a href="../../nn/http/ResultSocketConnectErr/Overview.html"><CODE>nn::http::ResultSocketConnectErr</CODE></a> 349 </th> 350<td>Indicates a socket connection error.</td> 351 </tr> 352 <tr> 353 <th> 354<a href="../../nn/http/ResultGetProxySettingErr/Overview.html"><CODE>nn::http::ResultGetProxySettingErr</CODE></a> 355 </th> 356<td>Indicates failure to get proxy value set by device.</td> 357 </tr> 358 <tr> 359 <th> 360<a href="../../nn/http/ResultNotImplementedErr/Overview.html"><CODE>nn::http::ResultNotImplementedErr</CODE></a> 361 </th> 362<td>Indicates that a process is not implemented.</td> 363 </tr> 364 <tr> 365 <th> 366<a href="../../nn/http/ResultTimeout/Overview.html"><CODE>nn::http::ResultTimeout</CODE></a> 367 </th> 368<td>Indicates a timeout.</td> 369 </tr> 370 <tr> 371 <th> 372<a href="../../nn/http/ResultSocketKeepAliveDisconnected/Overview.html"><CODE>nn::http::ResultSocketKeepAliveDisconnected</CODE></a> 373 </th> 374<td>Indicates that the server disconnected during keep-alive communications.</td> 375 </tr> 376 <tr> 377<th class="category" colspan="2">Other</th> 378 </tr> 379 <tr> 380 <th> 381<a href="../../nn/http/CertStore/Overview.html"><CODE>nn::http::CertStore</CODE></a> 382 </th> 383<td>Class representing an HTTPS certificate store. Use this to reuse the same CA certificate store with multiple HTTPS communication sessions.</td> 384 </tr> 385 <tr> 386 <th> 387<a href="../../nn/http/ClientCert/Overview.html"><CODE>nn::http::ClientCert</CODE></a> 388 </th> 389<td>Class representing an HTTPS client certificate. Use this to reuse the same client certificate with multiple HTTPS communication sessions.</td> 390 </tr> 391 <tr> 392 <th> 393<a href="../../nn/http/Connection/Overview.html"><CODE>nn::http::Connection</CODE></a> 394 </th> 395<td>Class that represents HTTP communication. A single instance of this class is used for a <I>single HTTP communication session with a single URL</I>.</td> 396 </tr> </table> 397 </div> 398 </a> <a name="enum" id="enum"> 399<h2>Enumerated Types</h2> 400 <div class="section"> 401 <table class="members"> 402 <tr> 403 <td width="100"> </td> 404 <th> 405<a href="../../nn/http/RequestMethod.html"><CODE>RequestMethod</CODE></a> 406 </th> 407<td>HTTP request methods.</td> 408 </tr> 409 <tr> 410 <td width="100"> </td> 411 <th> 412<a href="../../nn/http/EncodingType.html"><CODE>EncodingType</CODE></a> 413 </th> 414<td>Encoding types for POST data.</td> 415 </tr> 416 <tr> 417 <td width="100"> </td> 418 <th> 419<a href="../../nn/http/PostDataType.html"><CODE>PostDataType</CODE></a> 420 </th> 421<td>Types of POST data.</td> 422 </tr> 423 <tr> 424 <td width="100"> </td> 425 <th> 426<a href="../../nn/http/Status.html"><CODE>Status</CODE></a> 427 </th> 428<td>Connection statuses.</td> 429 </tr> 430 <tr> 431 <td width="100"> </td> 432 <th> 433<a href="../../nn/http/ProxyAuthType.html"><CODE>ProxyAuthType</CODE></a> 434 </th> 435<td>Proxy authentication type.</td> 436 </tr> 437 <tr> 438 <td width="100"> </td> 439 <th> 440<a href="../../nn/http/ResultCode.html"><CODE>ResultCode</CODE></a> 441 </th> 442<td>Function result codes. Stored as <CODE>description</CODE> elements in the <CODE>Result</CODE> returned from API functions.</td> 443 </tr> </table> 444 </div> 445 </a> <a name="typedef" id="typedef"> 446<h2><CODE>typedef</CODE> Definitions</h2> 447 <div class="section"> 448 <table class="members"> 449 <tr> 450 <td width="100" /> 451 <th> 452<a href="../../nn/http/CertId.html"><CODE>CertId</CODE></a> 453 </th> 454<td>Certificate ID.</td> 455 </tr> 456 <tr> 457 <td width="100" /> 458 <th> 459<a href="../../nn/http/InternalCaCertId.html"><CODE>InternalCaCertId</CODE></a> 460 </th> 461<td>Built-in CA certificate ID. (Same meaning as the SSL library's <a href="../../nn/ssl/InternalCaCert.html"><CODE>nn::ssl::InternalCaCert</CODE></a> value.)</td> 462 </tr> 463 <tr> 464 <td width="100" /> 465 <th> 466<a href="../../nn/http/InternalClientCertId.html"><CODE>InternalClientCertId</CODE></a> 467 </th> 468<td>Built-in client certificate ID.((Same meaning as the <a href="../../nn/ssl/Overview.html">SSL</a> library's <a href="../../nn/ssl/InternalClientCert.html"><CODE>nn::ssl::InternalCaCert</CODE></a> value.)</td> 469 </tr> 470 <tr> 471 <td width="100" /> 472 <th> 473<a href="../../nn/http/CertStoreId.html"><CODE>CertStoreId</CODE></a> 474 </th> 475<td>Certificate store ID.</td> 476 </tr> 477 <tr> 478 <td width="100" /> 479 <th> 480<a href="../../nn/http/ConnectionHandle.html"><CODE>ConnectionHandle</CODE></a> 481 </th> 482<td>Connection handle ID. This corresponds to the handle ID that the NHTTP library assigns to each connection.</td> 483 </tr> </table> 484 </div> 485 </a> <a name="function" id="function"> 486<h2>Functions</h2> 487 <div class="section"> 488 <table class="members"> 489 <tr> 490<th class="category" colspan="3">Initialize/Finalize Entire Library</th> 491 </tr> 492 <tr> 493 <td width="100"> </td> 494 <th> 495<a href="../../nn/http/Initialize.html"><CODE>Initialize</CODE></a> 496 </th> 497<td>Initializes the HTTP library. Processes that link against the HTTP library must call this before using the library.</td> 498 </tr> 499 <tr> 500 <td width="100"> </td> 501 <th> 502<a href="../../nn/http/Finalize.html"><CODE>Finalize</CODE></a> 503 </th> 504<td>Finalizes the HTTP library. Processes that link against the HTTP library must call this after they are done using the library.</td> 505 </tr> </table> 506 </div> 507 </a> 508<h2>Revision History</h2> 509 <div class="section"> 510 <dl class="history"> 511 <dt>2010/06/14</dt> 512<dd>Initial version.<br /> 513 </dd> 514 </dl> 515 </div> 516 <hr><p>CONFIDENTIAL</p></body> 517</html>