Edit

Share via

Using Quality-of-Service (QoS) beacons to measure player latency to Azure

  • Article

You can deploy PlayFab multiplayer servers to more than a dozen Azure regions. There are two reasons to do this:

  1. Additional regions provide redundancy. If a single Azure region fails, players can access servers in other regions.
  2. Additional regions allow players to access servers that are "nearby" and deliver low-latency connectivity.

When you call RequestMultiplayerServer, you specify a ranked list of Azure regions that PlayFab uses to fulfill the request. PlayFab will attempt to fulfill the request using the #1 ranked region, but if there aren't servers standing by in that region, or the region has some other fault, a sub-optimal region further down the list will be attempted.

Whenever possible, you should use player latency data to inform the ranking of Azure regions used while requesting a multiplayer server. PlayFab provides services and tools to help with this task.

Quality-of-service beacons

PlayFab operates beacons in every Azure region in use by PlayFab multiplayer servers. These beacons will reflect UDP traffic and can be used to measure latency with UDP transport.

The usage of UDP is important, because most multiplayer games use UDP transport for their most performance-critical game traffic. Internet service providers and other elements of the Internet ecosystem may deliver differentiated performance for UDP vs. TCP vs. ICMP flows.

This is the typical flow for using these beacons in the context of a player device:

  1. Login the player to PlayFab. This is typically done with a LoginWithCustomID or another login API.
  2. Call ListQoSServersForTitle. This provides hostnames to PlayFab's QoS beacons. A typical implementation might have this procedure occur on the Multiplayer Menu page for the game.
  3. Create a UDP socket.
  4. Send a single UDP datagram to port 3075 on the QoS server. The message content must start with 0xFFFF (1111 1111 1111 1111).
  5. The server will reply with a single datagram, with the message contents having the first 2 bytes "flipped" to 0x0000 (0000 0000 0000 0000). The rest of the datagram contents will be copied from the initial ping.
  6. Measure the time between sending the UDP message and receiving a response.

Using the quality-of-service SDK

The PlayFab C# SDK and cross-platform (CPP) SDK provide an implementation of the QoS ping code. You can build an SDK and use it as a helper library in your PC games, reference the C# NuGet package, or use the code as an example for other platforms.

Each API returns a QosResult which contains a sorted list of regions along with the average ping time to each region.

C#

There is a QoS APIs available in the C# SDK. A sample implementation, WindowsRunnerCSharpClient, is available in the gsdkSamples repository.

The code is located in PlayFabQosApi.cs.

Parameters:

  • timeoutMs - The timeout (in milliseconds) applied to each ping attempt (Default: 250ms).
  • pingsPerRegion - The number of ping attempts to make against each region (Default: 10). Increasing this number will increase execution time, but reduce the chance of inaccurate results.
  • degreeOfParallelism - The maximum number of pings to make in parallel (Default: 4). Increasing this number will reduce execution time, but network contention can cause inaccurate results if this number is too large.
        public async Task<QosResult> GetQosResultAsync(
            int timeoutMs = DefaultTimeoutMs,
            int pingsPerRegion = DefaultPingsPerRegion,
            int degreeOfParallelism = DefaultDegreeOfParallelism)
        {

C++

There are the two QoS APIs available in the PlayFab cross-platform (CPP) SDK.

The code is located in PlayFabQosApi.cpp.

Parameters:

  • numThreads - The maximum number of pings to make in parallel. Increasing this number will reduce execution time, but network contention can cause inaccurate results if this number is too big.
  • timeoutMs - The timeout (in milliseconds) applied to each ping attempt (Default: 250ms).
  // Runs a QoS operation asynchronously. The operation pings a set of datacenters and returns a result with average response times.
  std::future<QoSResult> GetQoSResultAsync(unsigned int numThreads, unsigned int timeoutMs = DEFAULT_TIMEOUT_MS);

  // Runs a QoS operation synchronously. The operation pings a set of datacenters and returns a result with average response times.
  QoSResult GetQoSResult(unsigned int numThreads, unsigned int timeoutMs = DEFAULT_TIMEOUT_MS);