CTR Pia
4.11.3
Game Communication Engine
|
Represents the PiaSync
namespace.
More...
Classes | |
class | SyncProtocol |
This protocol is used for synchronized communication. Full mesh is the only network topology type that is supported. Note that star and relay mesh types are not supported. . More... | |
Functions | |
Finish Initialization | |
nn::Result | Initialize () |
Initializes the PiaSync 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) |
Indicates whether the PiaSync module is initialized. More... | |
void | Finalize (void) |
Finalizes the PiaSync module. Call this function before calling the nn::pia::common::Finalize function. More... | |
Represents the PiaSync
namespace.
2013-04-09 Removed the following: HidSync
, SyncProtocolOld
, StationAddressTable
, ResultInternalStateMismatch
, ResultSynchronizationIsLost
, ResultFailedToSynchronize
, and ResultInvalidDevice
.
2013-01-23 Increased the maximum number of stations available when using the HidSync
and SyncProtocolOld
classes.
2013-01-18 Added ResultDataIsNotSet
to the Result
values.
2012-10-19 Modified comments in the header field in accordance with changes to the format of the API reference.
2012-07-10 Deleted old Result
-related codes that had been left in the sync
namespace for compatibility reasons.
2012-05-07 The data sharing feature for the accelerometer and gyro sensor is now officially supported.
2012-05-07 Changed the Japanese spelling of 'sensor' in the Nintendo 3DS Terminology Guide.
2012-04-05 In accordance with the revision of the policy for managing results throughout Pia, the results for the sync
module have changed, and the references have been made to adhere to those changes.
2012-03-12 The APP_SPECIFIC_DEVICE
defined by the DeviceId
enumerated type can now be used by applications as an application-specific device. (Equivalent to the Beta version.)
2012-03-03 Added a caution when sharing gyro sensor data. For more information, see sync::SyncDeviceProfile
.
2012-02-22 Sharing of accelerometer and gyro sensor data has been implemented on a trial basis. Data sharing is equivalent to an Alpha version. Correct operation is not guaranteed at present.
2011-12-07 The severity of ResultSyncToBeImplemented
changed from SEVERITY_SHOULD_BE_HANDLED
to SEVERITY_PROGRAMMING_ERROR
. The severity of ResultSyncDataIsNotArrivedYet
changed from SEVERITY_IGNORABLE
to SEVERITY_SHOULD_BE_HANDLED
.
2011-11-29 Added ResultSyncInvalidDevice
to the Result
values.
2011-11-16 Provided the sync::ErrorReason
enumerated type.
2011-11-16 Discontinued the original plans to provide specifications for callback during synchronization start. Deleted a callback type definition.
2011-11-10 Added STATE_MASTER_REINITIALIZING
and STATE_CLIENT_REINITIALIZING
to the sync::State
enumeration.
2011-11-10 Added information about the Initialize
function's return values, which had been previously left out.
2011-10-31 Changed specifications for initialization processing beneath the sync
module, so that it is now performed during the setup period from the execution of the sync::BeginSetup
function until the execution of the sync::EndSetup
function.
2011-10-31 Removed arguments from the sync::Initialize
function.
2011-10-31 Changed specifications for the Initialize
function's return value from void
to nn::Result
.
2011-10-21 Added documentation.
2011-10-19 Released the alpha version.
nn::Result nn::pia::sync::BeginSetup | ( | void | ) |
Declares the start of setup.
Call this function before initializing the sync
module.
sync::BeginSetup
function, perform initialization in the sync
module, and promptly call the sync::EndSetup
function to complete setup.Result
value indicating success if it is called at the right time. nn::pia::ResultNotInitialized
Indicates that the sync::Initialize
function has not been called. Programming error. Fix your program so that this error is not returned.
nn::pia::ResultInvalidState
Indicates that this function is being called during the setup period. Programming error. Fix your program so that this error is not returned.
nn::Result nn::pia::sync::EndSetup | ( | void | ) |
Declares the end of setup.
Call this function after initializing the sync
module. Calling this function establishes memory to be consumed by the singleton sync
module and other modules, and optimizes memory management within the library.
BeginSetup
function, perform initialization in the sync
module, and promptly call the EndSetup
function to complete setup.Result
value indicating success if it is called at the right time.nn::pia::ResultNotInitialized
Indicates that the sync::Initialize
function has not been called. Programming error. Fix your program so that this error is not returned.
nn::pia::ResultInvalidState
Indicates that this function was called at the wrong time. Programming error. Fix your program so that this error is not returned.
void nn::pia::sync::Finalize | ( | void | ) |
Finalizes the PiaSync
module. Call this function before calling the nn::pia::common::Finalize
function.
All processing for the PiaSync
module must be ended before executing this function. Calling this function has no effect if the nn::pia::sync::Initialize
function has not been called.
nn::Result nn::pia::sync::Initialize | ( | ) |
Initializes the PiaSync
module. Execute the nn::pia::common::Initialize
function in advance.
Memory that the sync
module dynamically allocates and uses is allocated from memory passed by the nn::pia::common::Initialize
function.
Result
value indicating success if it is called at the right time. nn::pia::ResultInvalidState
Indicates that the function has already been executed and initialization has completed.bool nn::pia::sync::IsInitialized | ( | void | ) |
Indicates whether the PiaSync
module is initialized.
true
if initialized, and false
otherwise.