nn::boss::NsaList

nn::boss::NsaList Class

Syntax

class NsaList

Description

A class that handles all processing related to NSA lists. By specifying a file path for the NSA list, you can do things like download the NSA list to that path or parse the NSA list given by that path.

An NSA list is a collection of data (NSA items) that can be obtained by an NADL task. By getting this list, an application can allow users to choose which data to download. (For example, consider an NADL task that downloads items. If it gets an NSA list in advance, it can then tell the user which items are available and only download the ones that the user wants.

NSA lists have the following basic workflow.

1. Download an NSA list (NsaList::Download)
2. Verify the NSA list (NsaList::CheckValidity)
3. Parse the NSA list (NsaList::Parse)

After parsing a list, you can get a variety of NSA information with the NsaInformation type. Using the NsaInformation element's fileName value, you can construct a URL for an NADL task to download. (A download URL for an NADL task has the following composition. The value of fileName corresponds to [Filename] below. [BOSS Code] is a random string assigned to your application when you apply to use NADL tasks. [Task ID] is the relevant task ID. In other words, an application can establish a URL once [Filename] has been determined.

https://npdl.cdn.nintendowifi.net/p01/nsa/[BOSS Code]/[Task ID]/[Filename]

Structures

nn::boss::NsaList::NsaInformation A structure that stores all the NSA data in a parsed NSA list.
nn::boss::NsaList::SearchAttributes Search elements used to specify which NSA to include in an NSA list when you download it (when you call the NsaList::Download function).

Enumerated Types

ParseResult Definitions of NsaList::Parse results.

Member Constants

S NN_BOSS_NSALIST_WAIT_FINISH_TIMEOUT_DEFAULT_SEC const u32 Default value definition for the timeout (in sec) used by Download().
S NN_BOSS_NSALIST_MAX_SIZE const s64 A definition of the maximum file size for the NSA list downloaded by the Download function.

Member Functions

NsaList Constructor.
V ~NsaList Destructor.
Download Downloads the NSA list.
Cancel Cancels download of the NSA list.
GetHttpStatusCode Gets the HTTP status code received when an NSA list is downloaded.
GetResult Gets the result code for an NSA list download.
Parse Parses the NSA list and stores each NSA information found in an array.
GetDigest Gets the digest value included in an NSA list.
CheckValidity Checks the validity of an NSA list. (This confirms that the digest value included in the list matches the digest value calculated from the data in the list.)

Revision History

2011/10/27
Initial version.

CONFIDENTIAL