Edit

PartyRegionUpdateConfiguration

  • Article

The configuration used by the Party library to control how it performs automatic region discovery and connection quality measurement updates.

Syntax

struct PartyRegionUpdateConfiguration {  
    PartyRegionUpdateMode mode;  
    uint32_t refreshIntervalInSeconds;  
}

Members

mode   PartyRegionUpdateMode

The mode controlling when region discovery and connection quality measurement updates are performed.

The default value is PartyRegionUpdateMode::Immediate when PartyOption::RegionUpdateConfiguration hasn't been configured.

refreshIntervalInSeconds   uint32_t

The number of seconds allowed to elapse after region quality measurements complete before a new region discovery and connection quality measurement process may begin.

This refresh interval is used whenever a PartyRegionsChangedStateChange is provided to determine when the next region quality measurement is eligible to start under the update mode defined by the mode field.

Becoming eligible for a refresh doesn't guarantee that the refresh begins at that exact time. If the mode field is set to PartyRegionUpdateMode::Deferred, the next refresh doesn't happen until one of the applicable methods is called to trigger a region update. The library also waits until the local device is no longer in any Party networks and applies a small amount of randomized delay to try to avoid PlayFab service load from multiple, unintentionally synchronized devices.

The default value is 28800 (8 hours) when PartyOption::RegionUpdateConfiguration hasn't been configured.

A value of zero causes the Party library to never automatically refresh measurements in the future. Otherwise, the minimum allowed value is 30 seconds.

Remarks

This structure can be used together with PartyOption::RegionUpdateConfiguration to either override or query the Party library's current configuration via PartyManager::SetOption() or PartyManager::GetOption() respectively. It configures the behavior of the region discovery and connection quality measurement process that produces PartyRegionsChangedStateChange state changes.

Requirements

Header: Party.h

See also

Party members
PartyOption::RegionUpdateConfiguration
PartyRegionUpdateMode
PartyRegionsChangedStateChange
PartyManager::SetOption
PartyManager::GetOption