CTR Pia  4.11.3
Game Communication Engine
nn::pia::session Namespace Reference

Represents the PiaSession namespace. More...

Classes

class  CreateSessionSetting
 Base class that manages settings specific to session creation. More...
 
class  ISessionInfo
 An interface to the session's information. More...
 
class  ISessionInfoList
 The interface for the session information list. More...
 
class  JoinSessionSetting
 Base class that manages settings specific to session joining. More...
 
class  Mesh
 Contains member functions that manage connections with other devices. More...
 
class  Session
 This class contains processes for matchmaking and for creating and joining sessions used for P2P communication. More...
 
class  SessionSearchCriteria
 The base class for the search criteria used when searching for sessions. More...
 
class  SessionStationInfo
 Represents information about a station that is participating in a session. More...
 
class  UpdateSessionSetting
 Base class that manages settings specific to session criteria updates. More...
 

Enumerations

Functions

Module Initialization and Finalization
nn::Result Initialize ()
 Initializes the PiaSession module. Execute the nn::pia::common::Initialize function in advance. More...
 
nn::Result BeginSetup (void)
 Declares the start of setup. More...
 
nn::Result EndSetup (void)
 Declares the end of setup. More...
 
bool IsInitialized (void)
 Returns whether the PiaSession module is initialized. More...
 
void Finalize (void)
 Finalizes the PiaSession module. Call this function before calling the nn::pia::common::Finalize function. More...
 

Variables

static const u32 INVALID_SESSION_ID = 0
 Constant that indicates an invalid SessionId.
 
static const u32 NN_PIA_SESSION_DESTROY_TIMEOUT_DEFAULT = 5000
 The default value of the timeout time (in milliseconds) for the DestroyMesh process.
 
static const s32 NN_PIA_SESSION_INVALID_UPLINK_BIT_RATE_LOWER_LIMIT = -1
 This constant represents an invalid bitrate in the bitrate detection feature.
 
static const u32 NN_PIA_SESSION_JOIN_TIMEOUT_DEFAULT = 15000
 The default value of the timeout time (in milliseconds) for the JoinMesh process.
 
static const s32 NN_PIA_SESSION_KEEP_ALIVE_INTERVAL_DEFAULT = 1000
 The default value for the sending interval (in milliseconds) for keep-alive.
 
static const u32 NN_PIA_SESSION_LEAVE_TIMEOUT_DEFAULT = 5000
 The default value of the timeout time (in milliseconds) for the LeaveMesh process.
 
static const u16 NN_PIA_SESSION_MAX_RTT_DEFAULT = 500
 The default maximum total RTT (in milliseconds) for a relay route.
 
static const s32 NN_PIA_SESSION_MAX_SILENCE_TIME_DEFAULT = 10000
 The default value for the amount of time without communication (in milliseconds) after which it is determined that the communication with the station has been disconnected.
 
static const s32 NN_PIA_SESSION_MAX_SILENCE_TIME_MAX = 30000
 The maximum value that can be set for the amount of time without communication (in milliseconds) after which it is determined that the communication with the station has been disconnected.
 
static const s32 NN_PIA_SESSION_MAX_SILENCE_TIME_MIN = 1000
 The minimum value that can be set for the amount of time without communication (in milliseconds) after which it is determined that the communication with the station has been disconnected.
 

Detailed Description

Represents the PiaSession namespace.


Revision History:

2014-02-03 Organized the results that are returned when Session::JoinSessionAsync or asynchronous processes fail, and increased the number of reasons for distinguishable asynchronous process failures.

2013-04-11 Changed the Result value returned when session::Initialize fails to a Result value indicating the cause of the failure. The failure conditions have not changed.

2012-12-19 Added a Result type that can be returned when asynchronous NAT traversal of the Session::JoinSession instance fails.

2012-09-26 Deleted the old Result typedef that had been left in for compatibility.

2012-08-23 Renamed some results in the session module.

2012-04-27 Both the class name and the connection information for another terminal, which mean different things, were Session, which could cause confusion. The latter was changed to session.

2012-04-06 Initial version.

Enumeration Type Documentation

Enumerated type for setting the bitrate detection feature.

Enumerator
BitRateCheck_Disable 

Do not measure the bitrate.

BitRateCheck_Enable 

Measure the bitrate.

Enumerated type for configuring the network topology of a mesh created with the Session class or the Mesh class.

This feature will be added to the Session class and the Mesh class in a future release.

Enumerator
NetworkTopology_FullMesh 

Full-Mesh Network Topology.

NetworkTopology_RelayMesh 

Mesh Network Topology With Relay Connections Enabled.

Function Documentation

nn::Result nn::pia::session::BeginSetup ( void  )

Declares the start of setup.

Call before executing initialization processing beneath the session module. In other words, call before executing the Session::CreateInstance function.

Because this function does not run correctly if competing with another module's setup processing, perform initialization in the local module, and promptly call the EndSetup function to complete setup.

Returns
Returns a Result value indicating success if called at the right time. Your application's implementation must ensure that this function does not return any errors.
Error Return Values:

ResultNotInitialized Indicates that the session::Initialize function has not been called. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Indicates that the function was called again during setup. Programming error. Fix your program so that this error is not returned.

nn::Result nn::pia::session::EndSetup ( void  )

Declares the end of setup.

Call after executing initialization processing beneath the session module. In other words, call after executing the Session::CreateInstance function.

Calling this function determines the amount of memory used by singletons and other objects in the session module, and optimizes memory management in the module.

Because this function does not run correctly if competing with another module's setup processing, perform initialization in the local module, and promptly call the EndSetup function to complete setup.

Returns
Returns a Result value indicating success if called at the right time. Your application's implementation must ensure that this function does not return any errors.
Error Return Values:

ResultNotInitialized Indicates that the session::Initialize function has not been called. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Indicates that the function was called at the wrong time. Programming error. Fix your program so that this error is not returned.

void nn::pia::session::Finalize ( void  )

Finalizes the PiaSession module. Call this function before calling the nn::pia::common::Finalize function.

Processing of all PiaSession modules must be finalized before executing this function. Calling this function has no effect if the nn::pia::session::Initialize function has not been called.

nn::Result nn::pia::session::Initialize ( )

Initializes the PiaSession module. Execute the nn::pia::common::Initialize function in advance.

Memory that the session module dynamically allocates and uses is allocated from memory passed by the nn::pia::common::Initialize function.

Returns
Returns a Result value indicating success if called at the right time. Your application's implementation must ensure that this function does not return any errors.
Error Return Values:

ResultInvalidState Indicates that the common module is not initialized. Programming error. Fix your program so that this error is not returned.

ResultAlreadyInitialized Indicates that the function has already been executed and initialization has completed. Programming error. Fix your program so that this error is not returned.

bool nn::pia::session::IsInitialized ( void  )

Returns whether the PiaSession module is initialized.

Returns
Returns true if initialized, and false otherwise.