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