nn::dlp::CTR Namespace

Description

The CTR DLP (Download Play) namespace.
(This can also be written without the ::CTR portion.)

Library that handles Download Play. For details on Download Play, see the Programming Manual.

Notes

Server Execution

When verifying operations, check a variety of server and client system versions. Operations related to system updates that occur through Download Play are guaranteed by the built-in application, Dlplay, and the DLP library. For this reason, you do not need to check the behavior of Download Play as it relates to system updates in your application. However, please check in your application that message display is turned on and off in accordance to the pNotice flag of the Server::Initialize function. To read about the pNotice flag, see the Function Reference for this function.

Classes

Result
nn::dlp::CTR::ResultAlreadyOccupiedWirelessDevice The wireless device is already occupied.
nn::dlp::CTR::ResultInvalidState The internal state is inappropriate for using the API.
nn::dlp::CTR::ResultOutOfRange The parameter used is out of range.
nn::dlp::CTR::ResultInvalidPointer The pointer argument is invalid.
nn::dlp::CTR::ResultInvalidHandle The handle argument is invalid.
nn::dlp::CTR::ResultInternalError An error occurred that cannot be handled from the application.
nn::dlp::CTR::ResultInvalidMediaType The media to be accessed is not supported.
nn::dlp::CTR::ResultFailedToAccessMedia Access to media failed.
nn::dlp::CTR::ResultChildTooLarge Too much NAND memory is required to import the child program.
nn::dlp::CTR::ResultInvalidRegion The child program has a different region than the parent.
nn::dlp::CTR::ResultInvalidDlpVersion Differs from expected DLP protocol version.
nn::dlp::CTR::ResultIncommutable Cannot communicate with the partner.
nn::dlp::CTR::ResultNoData There is no target data.
nn::dlp::CTR::ResultWirelessOff State where communication is not possible.
nn::dlp::CTR::ResultNotFoundServer Cannot find server.
nn::dlp::CTR::ResultServerIsFull No more clients can connect to the server.
nn::dlp::CTR::ResultDeniedFromServer The server refused the connection. Returned while server is distributing a child program.
nn::dlp::CTR::ResultConnectionTimeout The connection attempt timed out.
Other
nn::dlp::CTR::FakeClient Class for Download Play fake clients.
nn::dlp::CTR::FakeClientWithName Class for fake clients for Download Play.
nn::dlp::CTR::Server Class for Download Play servers.
nn::dlp::CTR::ServerWithName Class for servers for Download Play.

Structures

nn::dlp::CTR::ClientDiscoveredServer Event information when the EventDesc type is EVENT_TYPE_CLIENT_DISCOVERED_SERVER.
nn::dlp::CTR::ClientDiscoveredTitle Event information when the EventDesc type is EVENT_TYPE_CLIENT_DISCOVERED_TITLE.
nn::dlp::CTR::ClientStateWaitingInvite Event information when the EventDesc type is EVENT_TYPE_CLIENT_STATE_WAITING_INVITE.
nn::dlp::CTR::EventDesc Notification of an event occurring in DLP. The information changes depending on the type member.
nn::dlp::CTR::ClientStatus Client state and download progress.
nn::dlp::CTR::IconInfo Icon information.
nn::dlp::CTR::TitleInfo Information on a child program.
nn::dlp::CTR::ServerInfo Server information.
nn::dlp::CTR::RebootInfo A structure that stores information used to reconnect to a parent device after a reboot.

Enumerated Types

ClientState Client states.
ServerState Server states.
EventType Types of notification events.

typedef Definitions

NodeInfo Node information.

Constants

Size and Number Constants
MAX_CHILD_IMPORT_SIZE const size_t The maximum size of the child program.
SHORT_TITLE_NAME_LENGTH const s32 The length (in characters) of a child program's one-line name (including the NULL terminator).
LONG_TITLE_NAME_LENGTH const s32 The length (in characters) of a child program's two-line name (including the NULL terminator).
ICON_HEIGHT_PIXEL const s32 Icon height in pixels.
ICON_WIDTH_PIXEL const s32 Icon width in pixels.
ICON_PIXEL_COUNT const s32 The number of pixels in the icon.
RATING_INFO_SIZE const s32 Size of Parental Controls information/data.
MAX_NODE_NUM const u16 Maximum number of nodes that can exist in a network, including servers.
MAX_CLIENT_NUM const u16 Maximum number of clients that can connect to a server.
MAX_SCAN_NUM const u8 The maximum number of child programs that a client can scan at once.
MIN_NETWORK_BLOCK_BUFFER_NUM const size_t Minimum number for the network block buffer.
MAX_NETWORK_BLOCK_BUFFER_NUM const size_t Maximum number for the network block buffer.
MIN_NETWORK_BLOCK_BUFFER_SIZE const size_t Minimum size of the network block buffer.
MAX_NETWORK_BLOCK_BUFFER_SIZE const size_t Maximum size of the network block buffer.
MAX_CHILD_UDS_PASSPHRASE_LENGTH const size_t Maximum length of the UDS passphrase when a child is reconnecting (including NULL termination).

Functions

Definitions of Common Functions Used Throughout DLP
GetRebootInfo Gets the reconnection information needed to connect to the network after rebooting.
IsChild Determines whether the program that called this function is a child program.

Revision History

2012/07/04
Because the server is never run as the download application, deleted the description of the execution format of media that the server can execute.
2012/05/02
Added a caution about system updates.
2012/04/26
Added a caution about running a server as a downloadable application.
2012/04/13
Added condition for returning ResultDeniedFromServer.
2011/04/25
Added the note that the server can only run as card application (CCI).
2010/06/14
Initial version.

CONFIDENTIAL