Connection flow

The connection flow (or allocation flow) is the process by which the Allocations service reserves slots on a Relay server to group players into a match. The process involves two types of players: joining playersClosedA connecting player (or joining player) is a player that wants to join a host player for a game session on a Relay server. and host playersClosedA host player is a player that initiates a game session on a Relay server and generates a join code to share with other players. There is only one host player per game match.. The following list describes the high-level steps involved in the connection, or allocation, process.

  1. The host player requests an allocation

  2. The Allocations service selects a Relay server

  3. The Allocations service sends the connection data to the host player

  4. The host player binds to the Relay server

  5. The host player requests a join code

  6. The Allocations service returns a join code to the host player

  7. The host player shares the join code with joining players

  8. The joining players use the join code

  9. The Allocations service sends connection data to the joining player

  10. The joining player binds to the Relay server

  11. The joining player sends connection request

The host player requests an allocation

The host player initiates the connection flow by requesting an allocation from the Allocations service. The allocation request includes the maximum number of connectionsClosedAn integer that indicates the maximum number of peer connections a client allows to communicate with them. This parameter must be less than or equal to 100. the allocation should allow. It can also include a specific region. If the request doesn’t include a region, the Allocations service uses QoS to select the best region for the request.

The Allocations service selects a Relay server

The host uses the connection data from the Allocations service's response to bind the Allocation service selected for the allocation to the Relay. The Relay server selection depends on the maximum connections allowed and the region.

When the Allocations service finds a Relay server, it makes a call to allocate or reserve a space on the Relay server for the game session. At this point, the Relay server also generates a unique secret key. The Relay server returns the secret key to the Allocations service, in addition to the Relay server IP, the Relay server ports, and the connection data.

The Allocations service sends the connection data to the host player

The Allocations service sends the Relay server connection data to the host player's game client.

The host player binds to the Relay server

The host uses the connection data from the response from the Allocations service to send bind to the Relay the Allocation service selected for the allocation. The BIND message contains the connection data, the accept modeClosedThe accept mode defines how a Relay server should handle requests from clients trying to connect. The accept mode is always AUTO., nonce, and HMAC. If the host doesn’t send the bind to the Relay server within 10 seconds after making the allocation, the allocation times out from inactivity.

If the information in the request is accurate, the Relay server sends an acknowledges that the player is bound.

The host player requests a join code

Once bound to the Relay server, the host player can request a join code from the Allocations service.

The Allocations service returns a join code to the host player

The Allocations service generates and returns a join code to the host player. The join code the Allocations service returns uniquely represents the host player’s allocation to the Relay server, and allows joining players to connect to the host player and bind to the same Relay server.

The host player shares the join code with joining players

The host player shares the unique join code with other players through any method, including verbally, through a text message, or through a Lobby. The join codes are short and easy to remember to facilitate sharing.

The players that use the join code with a join request to the Allocations service become the joining players.

Note: Any number of joining players can use the same join code so long as the number does not exceed the maximum number of connectionsClosedAn integer that indicates the maximum number of peer connections a client allows to communicate with them. This parameter must be less than or equal to 100. specified in the initial allocation request.

The joining players use the join code

The joining players use the join code from the host player to send a join request to the Allocations service.

The Allocations service sends connection data to the joining player

The Allocations service uses the join code to look up the host player’s allocation and the associated connection data, then sends the connection data to the joining players.

The response from the Allocations service contains the Relay server IP address, the Relay server port, the secret key, the encrypted joining player’s connection data, the joining player’s allocation ID, and the encrypted host connection data. The joining player can then use the secret key to decrypt and use the host connection data to connect to the host.

The joining player binds to the Relay server

The joining player uses the connection data from the Allocations service to bind to the Relay server.

The joining player sends connection request

Once bound to the same Relay server as the host player, the joining player can send a connection request to the host player. If the connection request is successful, the joining player and the host players can send data to each other through the Relay server.