nn::dlp::CTR::ServerState Enumerated Type

Syntax

enum ServerState;

Value

Value Description
SERVER_STATE_INVALID The server is not initialized.
SERVER_STATE_INITIALIZED Initialization is complete.
SERVER_STATE_OPENED_SESSIONS Accepting session participation requests.
SERVER_STATE_PREPARING_FOR_SYSTEM_DISTRIBUTION Preparing for system distribution.
SERVER_STATE_DISTRIBUTING_SYSTEM Distributing system.
SERVER_STATE_WAITING_RECONNECT Waiting for clients who rebooted systems after system distribution to reconnect. Clients will not necessarily always reconnect.
SERVER_STATE_PREPARING_FOR_TITLE_DISTRIBUTION The server is preparing to distribute a child program.
SERVER_STATE_DISTRIBUTING_TITLE The server is distributing a child program.
SERVER_STATE_COMPLETE_DISTRIBUTION The server has finished distributing a child program.
SERVER_STATE_REBOOTING_CLIENTS Server is rebooting clients. After confirming that all clients are disconnected, quit Download Play. If carrying out local communication after that, wait for client connections via UDS.
Note: Clients will not always necessarily reconnect.
SERVER_STATE_ERROR An error has occurred, and reinitialization must occur. The conditions for transition are (1) entering sleep mode or entering wireless-disabled state between the Initialize function and the Finalize function, or (2) clients with any state other than CLIENT_STATE_RECONNECTING_NETWORK disconnecting after the download session begins (the set of states from SERVER_STATE_PREPARING_FOR_SYSTEM_DISTRIBUTION through to SERVER_STATE_COMPLETE_DISTRIBUTION), or (3) removal of the card.

Description

Server states.

Following a call to the StartDistribute function the distribution process will proceed and the SDK will automatically transition from the SERVER_STATE_PREPARING_FOR_SYSTEM_DISTRIBUTION state to the SERVER_STATE_COMPLETE_DISTRIBUTION state. However, during that time the state may also transition to SERVER_STATE_ERROR due to any number of factors (communications error, sleep mode, wireless-disabled state, etc.).
Use the GetState function or the GetEventDesc function to monitor the state.
Handle the whole set of states from SERVER_STATE_PREPARING_FOR_SYSTEM_DISTRIBUTION through to SERVER_STATE_DISTRIBUTING_TITLE as if distribution is taking place.
While in these states it is acceptable to display a message such as "Distributing" with the user interface. However, make sure that users can cancel distribution at any time.
This is because the DLP server continues to wait for rebooted clients to reconnect after a system update. All clients, however, will not necessarily reconnect.

Revision History

2010/08/16
Initial version.

CONFIDENTIAL