nn::http Namespace

Description

Namespace for the HTTP communication API.

Note: This library is provided for debugging purposes. If you intend to include it in your retail product, contact Nintendo at support@noa.com.

Classes

Result
nn::http::ResultInvalidStatusErr Indicates invalid status.
nn::http::ResultInvalidParamErr Indicates invalid parameter.
nn::http::ResultOutOfMemoryErr Indicates dynamic memory allocation failure.
nn::http::ResultCreateEventErr Indicates failure to create an event.
nn::http::ResultCreateMutexErr Indicates failure to create a mutex.
nn::http::ResultCreateQueueErr Indicates failure to create a message queue.
nn::http::ResultCreateThreadErr Indicates failure to create a thread.
nn::http::ResultNotConnectedErr Indicates that the connection is not initialized.
nn::http::ResultAlreadyAssignHostErr Indicates that the remote host has already been allocated.
nn::http::ResultSessionErr Indicates an invalid IPC session.
nn::http::ResultClientProcessMaxErr Indicates that the maximum number of simultaneous client processes are already being used.
nn::http::ResultIpcSessionMaxErr Indicates that the maximum number of simultaneous IPC sessions are already connected.
nn::http::ResultAlreadyInitializedErr Indicates that a library is already initialized.
nn::http::ResultNotInitializedErr Indicates that a library is not initialized.
nn::http::ResultMessageSendToListenThreadErr Indicates a listener thread message queue sending failure.
nn::http::ResultMessageRecvInListenThreadErr Indicates a listener thread message queue reception failure.
nn::http::ResultMessageRecvInCommunicationThreadErr Indicates a communication thread message queue reception failure.
nn::http::ResultConnectionNoMoreErr Indicates that the maximum number of registerable connection handles has been exceeded.
nn::http::ResultNoSuchConnectionErr Indicates a request for an operation on a nonexistent connection.
nn::http::ResultConnectionStatusErr Indicates an invalid connection status.
nn::http::ResultConnectionAddErr Indicates a failure to register a connection.
nn::http::ResultConnectionCanceledErr Indicates that the connection was canceled.
nn::http::ResultConnectionHostMaxErr Indicates that the maximum number of simultaneous connections to the same host has been exceeded.
nn::http::ResultConnectionProcessMaxErr Indicates that the maximum number of connections used by one process has been exceeded.
nn::http::ResultRequestUrlErr Indicates an invalid URL.
nn::http::ResultRequestPortErr Indicates an invalid port on the remote host.
nn::http::ResultRequestUnknownMethodErr Indicates an unknown method.
nn::http::ResultRequestHeaderErr Indicates an invalid HTTP header.
nn::http::ResultRequestNoNewLineErr Indicates no newline in an HTTP header.
nn::http::ResultBodyBufErr Indicates an HTTP body receive buffer error.
nn::http::ResultBodyBufShortage Indicates insufficient space in the HTTP body receive buffer.
nn::http::ResultPostAddedAnotherErr Indicates a failure to add POST data.
nn::http::ResultPostBoundaryErr Indicates that the POST data boundary could not be properly set.
nn::http::ResultPostSendErr Indicates a POST request sending failure.
nn::http::ResultPostUnknownEnctypeErr Indicates an unknown encoding for POST data.
nn::http::ResultPostNoDataErr Indicates that no settings have been configured for sending POST data.
nn::http::ResultSslErr Indicates an SSL error.
nn::http::ResultCertExistErr Indicates that the SSL certificate is already set (must be deleted before re-registering).
nn::http::ResultNoCaCertStoreErr Indicates that no such SSL CA certificate store is registered.
nn::http::ResultNoClientCertErr Indicates that no such SSL client certificate is registered.
nn::http::ResultCaCertStoreMaxErr Indicates that the maximum number of simultaneously registerable SSL per-process CA certificate stores is already registered.
nn::http::ResultClientCertMaxErr Indicates that the maximum number of simultaneously registerable SSL per-process client certificates is already registered.
nn::http::ResultFailToCreateCertStoreErr Indicates a failure to create an SSL certificate store.
nn::http::ResultFailToCreateClientCertErr Indicates a failure to create an SSL client certificate.
nn::http::ResultDnsResolutionErr Indicates a DNS name resolution failure.
nn::http::ResultSocketSendErr Indicates a socket data sending error.
nn::http::ResultSocketReceiveErr Indicates a socket data reception error.
nn::http::ResultSocketConnectErr Indicates a socket connection error.
nn::http::ResultGetProxySettingErr Indicates failure to get proxy value set by device.
nn::http::ResultNotImplementedErr Indicates that a process is not implemented.
nn::http::ResultTimeout Indicates a timeout.
nn::http::ResultSocketKeepAliveDisconnected Indicates that the server disconnected during keep-alive communications.
Other
nn::http::CertStore Class representing an HTTPS certificate store. Use this to reuse the same CA certificate store with multiple HTTPS communication sessions.
nn::http::ClientCert Class representing an HTTPS client certificate. Use this to reuse the same client certificate with multiple HTTPS communication sessions.
nn::http::Connection Class that represents HTTP communication. A single instance of this class is used for a single HTTP communication session with a single URL.

Enumerated Types

RequestMethod HTTP request methods.
EncodingType Encoding types for POST data.
PostDataType Types of POST data.
Status Connection statuses.
ProxyAuthType Proxy authentication type.
ResultCode Function result codes. Stored as description elements in the Result returned from API functions.

typedef Definitions

CertId Certificate ID.
InternalCaCertId Built-in CA certificate ID. (Same meaning as the SSL library's nn::ssl::InternalCaCert value.)
InternalClientCertId Built-in client certificate ID.((Same meaning as the SSL library's nn::ssl::InternalCaCert value.)
CertStoreId Certificate store ID.
ConnectionHandle Connection handle ID. This corresponds to the handle ID that the NHTTP library assigns to each connection.

Functions

Initialize/Finalize Entire Library
Initialize Initializes the HTTP library. Processes that link against the HTTP library must call this before using the library.
Finalize Finalizes the HTTP library. Processes that link against the HTTP library must call this after they are done using the library.

Revision History

2010/06/14
Initial version.

CONFIDENTIAL