CTR Pia
4.11.3
Game Communication Engine
|
Represents the PiaLocal
namespace.
More...
Classes | |
class | LocalAroundNetworkInfo |
Class that holds information about the network discovered using nearby network search. More... | |
class | LocalAroundNetworkSearchSetting |
Class for configuring the nearby network search feature. More... | |
class | LocalConnectNetworkSetting |
Class for configuring a connection to a local network. More... | |
class | LocalCreateNetworkSetting |
Class for configuring the creation of a local network. More... | |
class | LocalCreateSessionSetting |
Base class that manages the settings for the CreateSession function with a LocalNetwork object. More... | |
class | LocalFacade |
Represents the facade (interface wrapper) class for the local communication library. . More... | |
class | LocalJoinSessionSetting |
Base class that manages the settings for the JoinSession function with a LocalNetwork object. More... | |
class | LocalNetwork |
Class for handling the local network. More... | |
class | LocalNetworkDescription |
Class that holds information about a local network. More... | |
class | LocalNetworkFactory |
Base class for creating the classes required for a network that uses the LocalNetwork class. It implements the factory pattern. More... | |
class | LocalNetworkSetting |
Class for configuring a local network. More... | |
class | LocalSessionInfo |
Data class for local communication sessions. More... | |
class | LocalSessionSearchCriteria |
The search condition class used when searching for a matchmaking session using LocalNetwork . More... | |
class | LocalSessionStationInfo |
Represents information about a station that is participating in a session. More... | |
class | LocalStationInfo |
Class that holds information about stations connected to a local network. More... | |
class | UdsAroundNetworkInfo |
Class that holds information about a network discovered via the nearby network search feature, using the UDS library. More... | |
class | UdsConnectNetworkSetting |
Class for configuring connections to networks that use the UDS library. More... | |
class | UdsCreateNetworkSetting |
Class for configuring the creation of networks that use the UDS library. More... | |
class | UdsCreateSessionSetting |
Class that manages the CreateSession settings for networks using the UDS library (local communication). More... | |
class | UdsJoinSessionSetting |
Class that manages JoinSession settings in LocalNetwork sessions. More... | |
class | UdsNetworkDescription |
Class that holds information about networks that use the UDS library. More... | |
class | UdsNetworkFactory |
This class creates the necessary classes for networks using LocalNetwork objects. It implements the factory pattern. More... | |
class | UdsNetworkSetting |
Class for configuring networks that use the UDS library. More... | |
class | UdsSessionInfo |
Data class for local communication sessions. More... | |
class | UdsStationInfo |
Class that holds information about stations that are connected to a network that uses the UDS library. More... | |
Functions | |
Finish Initialization | |
nn::Result | Initialize () |
Initializes the local module. More... | |
bool | IsInitialized (void) |
Gets whether the local module is initialized. More... | |
nn::Result | BeginSetup (void) |
Declares the start of setup. More... | |
nn::Result | EndSetup (void) |
Declares the end of setup. More... | |
void | Finalize (void) |
Finalizes the local module. More... | |
Variables | |
static const u32 | DEFAULT_AROUND_NETWORK_SEARCH_NETWORK_LIFE_TIME = 5000 |
Default value, in milliseconds, for the holding period for a discovered network during nearby network search. | |
static const u32 | DEFAULT_AROUND_NETWORK_SEARCH_SCAN_INTERVAL = 200 |
Default value, in milliseconds, for the scan interval during nearby network search. | |
static const u16 | DEFAULT_AROUND_NETWORK_SEARCH_SCAN_TIME = 20 |
Default value, in milliseconds, for the scan time during nearby network search. | |
const u32 | GATHERINGHOLDER_MAX_SIZE = SCAN_NETWORK_NUM_MAX |
The maximum number of network scan results to keep. | |
static const u32 | SCAN_NETWORK_NUM_MAX = 16 |
Defines the maximum number of search results that can be stored at one time when performing a network search. | |
static const u8 | STATION_MAX_ENTRY = 12 |
The maximum number of nodes that can connect. The local network host is included in the number of connected nodes. | |
static const size_t | UDS_APPLICATION_DATA_SIZE_MAX = nn::uds::NET_DESC_APPDATA_SIZE_MAX |
Maximum size of the application data that can be set for the beacon. The size available for the application to use will be less than this amount because the size includes a region for system use. | |
static const size_t | UDS_PASSPHRASE_LENGTH_MAX = nn::uds::UDS_PASSPHRASE_LENGTH_MAX |
Maximum size of the passphrase for generating the encryption key used in communication. | |
static const size_t | UDS_PASSPHRASE_LENGTH_MIN = nn::uds::UDS_PASSPHRASE_LENGTH_MIN |
Minimum size of the passphrase for generating the encrypted key used in communication. | |
static const u32 | UDS_RECEIVE_BUFFER_SIZE_MIN = 4 * 4096 |
Defines the minimum receive buffer size. | |
static const u32 | UDS_SCAN_BUFFER_SIZE_MIN = 1 * 1024 |
Minimum size of the scan buffer. | |
Represents the PiaLocal
namespace.
2014-04-04 Removed the UdsNode
function. Use the LocalNetwork
function instead.
2012-10-29 Categorized member functions to improve readability of the API reference.
2012-10-19 Modified comments in the header field in accordance with changes to the format of the API reference.
2012-07-19 Changed the name of the "NEX Local Communication Linking Feature" to "NetZ Local Communication Linking Feature."
2012-07-10 Deleted old Result
-related codes that had been left in the local
namespace for compatibility reasons.
2012-06-01 Revised the description of parameters (second parameter) passed to the local::UdsUpdateEventCallback
function.
2012-05-01 Added the header files included in local.h
. All headers required to use the local
module are included if you include local.h
. (This does not include the NEX local network link feature.)
2012-04-10 Initial version. Revision histories are listed individually for Pia 1.7.0 or later.
nn::Result nn::pia::local::BeginSetup | ( | void | ) |
Declares the start of setup.
Call this function before initializing objects in the local
module (before calling LocalNetwork::CreateInstance
and LocalNetwork::Initialize
).
BeginSetup
function, perform initialization in the local
module, and promptly call the EndSetup
function to complete setup.Result
value indicating success if it is called at the right time.ResultNotInitialized
Indicates that the local
module has not been initialized.
ResultInvalidState
Indicates that the function was called at the wrong time.
nn::Result nn::pia::local::EndSetup | ( | void | ) |
Declares the end of setup.
Call this function after initializing objects below the local
module (after calling LocalNetwork::CreateInstance
and LocalNetwork::Initialize
). Calling this function configures memory to be used by the local
module singletons and optimizes memory management within the library.
BeginSetup
function, perform initialization in the local
module, and promptly call the EndSetup
function to complete setup.Result
value indicating success if it is called at the right time.ResultNotInitialized
Indicates that the local
module has not been initialized.
ResultInvalidState
Indicates that the function was called at the wrong time.
void nn::pia::local::Finalize | ( | void | ) |
Finalizes the local
module.
Processing of all PiaLocal
modules must be finalized before executing this function. Calling this function has no effect if the nn::pia::local::Initialize
function has not been called.
nn::Result nn::pia::local::Initialize | ( | ) |
Initializes the local
module.
Execute the nn::pia::common::Initialize
function in advance.
Result
value indicating success if initialization succeeds.ResultInvalidState
Indicates that nn::pia::common
has not been initialized.
ResultAlreadyInitialized
Indicates that the module is already initialized.
bool nn::pia::local::IsInitialized | ( | void | ) |
Gets whether the local
module is initialized.
true
if initialized, or false
otherwise.