CTR Pia  4.11.3
Game Communication Engine
nn::pia::sync::SyncProtocol::Setting Struct Reference

Stores settings specified during initialization. More...

Public Member Functions

 Setting ()
 Instantiates the object with default parameters (default constructor). More...
 

Public Attributes

u32 m_DataCompressionLevel
 Sets the compression level for synchronized data. More...
 
size_t m_DataUnitSize [DATA_ID_NUM+RESERVED_DATA_ID_NUM]
 Sets the size of the data to send for each data ID. More...
 
bool m_IsUsingChangeDelay
 Enables or disables use of the change delay feature while communication is synchronized.
 
u32 m_MaxDelay
 Defines the maximum number of frames of input delay. More...
 
u32 m_TimeoutFrame
 Ends synchronization due to a timeout if packets cannot be received consecutively for the specified number of frames (number of calls to SyncProtocol::Step). More...
 

Detailed Description

Stores settings specified during initialization.

Specify the same values on stations using data synchronization.

Constructor & Destructor Documentation

nn::pia::sync::SyncProtocol::Setting::Setting ( )

Instantiates the object with default parameters (default constructor).

This function initializes the object using default values.

Member Data Documentation

u32 nn::pia::sync::SyncProtocol::Setting::m_DataCompressionLevel

Sets the compression level for synchronized data.

Not compressed when SyncProtocol::COMPRESSION_LEVEL_NONE is specified. Specifying SyncProtocol::COMPRESSION_LEVEL_LOW emphasizes speed; SyncProtocol::COMPRESSION_LEVEL_HIGH emphasizes the compression rate. Specifying SyncProtocol::COMPRESSION_LEVEL_MIDDLE results in an intermediate level of compression between the other two. The default value is SyncProtocol::COMPRESSION_LEVEL_NONE. Other values are not supported. Execution time varies significantly based on the CPU performance of the platform.

size_t nn::pia::sync::SyncProtocol::Setting::m_DataUnitSize[DATA_ID_NUM+RESERVED_DATA_ID_NUM]

Sets the size of the data to send for each data ID.

Specify 0 for unused data IDs. You can use the SyncProtocol::GetDataUnitSizeMax function to find out the largest size this value can be set to.

See also
SyncProtocol::GetDataUnitSizeMax
u32 nn::pia::sync::SyncProtocol::Setting::m_MaxDelay

Defines the maximum number of frames of input delay.

Specify a value between 1 and FRAME_DELAY_MAX.

Note: To set a value equivalent to the delays set in the HidSync and SyncProtocolOld classes, you must specify a value 1 greater than the values set in those classes.

u32 nn::pia::sync::SyncProtocol::Setting::m_TimeoutFrame

Ends synchronization due to a timeout if packets cannot be received consecutively for the specified number of frames (number of calls to SyncProtocol::Step).

If you specify 0, the object continues to wait for packets forever, and data synchronization never times out.