AWS SDK for C++  1.9.108
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::GameSessionConnectionInfo Class Reference

#include <GameSessionConnectionInfo.h>

Public Member Functions

 GameSessionConnectionInfo ()
 
 GameSessionConnectionInfo (Aws::Utils::Json::JsonView jsonValue)
 
GameSessionConnectionInfooperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetGameSessionArn () const
 
bool GameSessionArnHasBeenSet () const
 
void SetGameSessionArn (const Aws::String &value)
 
void SetGameSessionArn (Aws::String &&value)
 
void SetGameSessionArn (const char *value)
 
GameSessionConnectionInfoWithGameSessionArn (const Aws::String &value)
 
GameSessionConnectionInfoWithGameSessionArn (Aws::String &&value)
 
GameSessionConnectionInfoWithGameSessionArn (const char *value)
 
const Aws::StringGetIpAddress () const
 
bool IpAddressHasBeenSet () const
 
void SetIpAddress (const Aws::String &value)
 
void SetIpAddress (Aws::String &&value)
 
void SetIpAddress (const char *value)
 
GameSessionConnectionInfoWithIpAddress (const Aws::String &value)
 
GameSessionConnectionInfoWithIpAddress (Aws::String &&value)
 
GameSessionConnectionInfoWithIpAddress (const char *value)
 
const Aws::StringGetDnsName () const
 
bool DnsNameHasBeenSet () const
 
void SetDnsName (const Aws::String &value)
 
void SetDnsName (Aws::String &&value)
 
void SetDnsName (const char *value)
 
GameSessionConnectionInfoWithDnsName (const Aws::String &value)
 
GameSessionConnectionInfoWithDnsName (Aws::String &&value)
 
GameSessionConnectionInfoWithDnsName (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
GameSessionConnectionInfoWithPort (int value)
 
const Aws::Vector< MatchedPlayerSession > & GetMatchedPlayerSessions () const
 
bool MatchedPlayerSessionsHasBeenSet () const
 
void SetMatchedPlayerSessions (const Aws::Vector< MatchedPlayerSession > &value)
 
void SetMatchedPlayerSessions (Aws::Vector< MatchedPlayerSession > &&value)
 
GameSessionConnectionInfoWithMatchedPlayerSessions (const Aws::Vector< MatchedPlayerSession > &value)
 
GameSessionConnectionInfoWithMatchedPlayerSessions (Aws::Vector< MatchedPlayerSession > &&value)
 
GameSessionConnectionInfoAddMatchedPlayerSessions (const MatchedPlayerSession &value)
 
GameSessionConnectionInfoAddMatchedPlayerSessions (MatchedPlayerSession &&value)
 

Detailed Description

Connection information for a new game session that is created in response to a StartMatchmaking request. Once a match is made, the FlexMatch engine creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the MatchmakingTicket, which can be retrieved by calling DescribeMatchmaking.

See Also:

AWS API Reference

Definition at line 38 of file GameSessionConnectionInfo.h.

Constructor & Destructor Documentation

◆ GameSessionConnectionInfo() [1/2]

Aws::GameLift::Model::GameSessionConnectionInfo::GameSessionConnectionInfo ( )

◆ GameSessionConnectionInfo() [2/2]

Aws::GameLift::Model::GameSessionConnectionInfo::GameSessionConnectionInfo ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddMatchedPlayerSessions() [1/2]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::AddMatchedPlayerSessions ( const MatchedPlayerSession value)
inline

A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

Definition at line 315 of file GameSessionConnectionInfo.h.

◆ AddMatchedPlayerSessions() [2/2]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::AddMatchedPlayerSessions ( MatchedPlayerSession &&  value)
inline

A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

Definition at line 321 of file GameSessionConnectionInfo.h.

◆ DnsNameHasBeenSet()

bool Aws::GameLift::Model::GameSessionConnectionInfo::DnsNameHasBeenSet ( ) const
inline

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 163 of file GameSessionConnectionInfo.h.

◆ GameSessionArnHasBeenSet()

bool Aws::GameLift::Model::GameSessionConnectionInfo::GameSessionArnHasBeenSet ( ) const
inline

A unique identifier for the game session. Use the game session ID.

Definition at line 55 of file GameSessionConnectionInfo.h.

◆ GetDnsName()

const Aws::String& Aws::GameLift::Model::GameSessionConnectionInfo::GetDnsName ( ) const
inline

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 149 of file GameSessionConnectionInfo.h.

◆ GetGameSessionArn()

const Aws::String& Aws::GameLift::Model::GameSessionConnectionInfo::GetGameSessionArn ( ) const
inline

A unique identifier for the game session. Use the game session ID.

Definition at line 50 of file GameSessionConnectionInfo.h.

◆ GetIpAddress()

const Aws::String& Aws::GameLift::Model::GameSessionConnectionInfo::GetIpAddress ( ) const
inline

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 92 of file GameSessionConnectionInfo.h.

◆ GetMatchedPlayerSessions()

const Aws::Vector<MatchedPlayerSession>& Aws::GameLift::Model::GameSessionConnectionInfo::GetMatchedPlayerSessions ( ) const
inline

A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

Definition at line 279 of file GameSessionConnectionInfo.h.

◆ GetPort()

int Aws::GameLift::Model::GameSessionConnectionInfo::GetPort ( ) const
inline

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 254 of file GameSessionConnectionInfo.h.

◆ IpAddressHasBeenSet()

bool Aws::GameLift::Model::GameSessionConnectionInfo::IpAddressHasBeenSet ( ) const
inline

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 98 of file GameSessionConnectionInfo.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::GameLift::Model::GameSessionConnectionInfo::Jsonize ( ) const

◆ MatchedPlayerSessionsHasBeenSet()

bool Aws::GameLift::Model::GameSessionConnectionInfo::MatchedPlayerSessionsHasBeenSet ( ) const
inline

A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

Definition at line 285 of file GameSessionConnectionInfo.h.

◆ operator=()

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ PortHasBeenSet()

bool Aws::GameLift::Model::GameSessionConnectionInfo::PortHasBeenSet ( ) const
inline

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 260 of file GameSessionConnectionInfo.h.

◆ SetDnsName() [1/3]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetDnsName ( Aws::String &&  value)
inline

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 191 of file GameSessionConnectionInfo.h.

◆ SetDnsName() [2/3]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetDnsName ( const Aws::String value)
inline

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 177 of file GameSessionConnectionInfo.h.

◆ SetDnsName() [3/3]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetDnsName ( const char *  value)
inline

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 205 of file GameSessionConnectionInfo.h.

◆ SetGameSessionArn() [1/3]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetGameSessionArn ( Aws::String &&  value)
inline

A unique identifier for the game session. Use the game session ID.

Definition at line 65 of file GameSessionConnectionInfo.h.

◆ SetGameSessionArn() [2/3]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetGameSessionArn ( const Aws::String value)
inline

A unique identifier for the game session. Use the game session ID.

Definition at line 60 of file GameSessionConnectionInfo.h.

◆ SetGameSessionArn() [3/3]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetGameSessionArn ( const char *  value)
inline

A unique identifier for the game session. Use the game session ID.

Definition at line 70 of file GameSessionConnectionInfo.h.

◆ SetIpAddress() [1/3]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetIpAddress ( Aws::String &&  value)
inline

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 110 of file GameSessionConnectionInfo.h.

◆ SetIpAddress() [2/3]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetIpAddress ( const Aws::String value)
inline

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 104 of file GameSessionConnectionInfo.h.

◆ SetIpAddress() [3/3]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetIpAddress ( const char *  value)
inline

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 116 of file GameSessionConnectionInfo.h.

◆ SetMatchedPlayerSessions() [1/2]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetMatchedPlayerSessions ( Aws::Vector< MatchedPlayerSession > &&  value)
inline

A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

Definition at line 297 of file GameSessionConnectionInfo.h.

◆ SetMatchedPlayerSessions() [2/2]

void Aws::GameLift::Model::GameSessionConnectionInfo::SetMatchedPlayerSessions ( const Aws::Vector< MatchedPlayerSession > &  value)
inline

A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

Definition at line 291 of file GameSessionConnectionInfo.h.

◆ SetPort()

void Aws::GameLift::Model::GameSessionConnectionInfo::SetPort ( int  value)
inline

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 266 of file GameSessionConnectionInfo.h.

◆ WithDnsName() [1/3]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithDnsName ( Aws::String &&  value)
inline

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 233 of file GameSessionConnectionInfo.h.

◆ WithDnsName() [2/3]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithDnsName ( const Aws::String value)
inline

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 219 of file GameSessionConnectionInfo.h.

◆ WithDnsName() [3/3]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithDnsName ( const char *  value)
inline

The DNS identifier assigned to the instance that is running the game session. Values have the following format:

  • TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.

  • Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)

When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.

Definition at line 247 of file GameSessionConnectionInfo.h.

◆ WithGameSessionArn() [1/3]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithGameSessionArn ( Aws::String &&  value)
inline

A unique identifier for the game session. Use the game session ID.

Definition at line 80 of file GameSessionConnectionInfo.h.

◆ WithGameSessionArn() [2/3]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithGameSessionArn ( const Aws::String value)
inline

A unique identifier for the game session. Use the game session ID.

Definition at line 75 of file GameSessionConnectionInfo.h.

◆ WithGameSessionArn() [3/3]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithGameSessionArn ( const char *  value)
inline

A unique identifier for the game session. Use the game session ID.

Definition at line 85 of file GameSessionConnectionInfo.h.

◆ WithIpAddress() [1/3]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithIpAddress ( Aws::String &&  value)
inline

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 128 of file GameSessionConnectionInfo.h.

◆ WithIpAddress() [2/3]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithIpAddress ( const Aws::String value)
inline

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 122 of file GameSessionConnectionInfo.h.

◆ WithIpAddress() [3/3]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithIpAddress ( const char *  value)
inline

The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 134 of file GameSessionConnectionInfo.h.

◆ WithMatchedPlayerSessions() [1/2]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithMatchedPlayerSessions ( Aws::Vector< MatchedPlayerSession > &&  value)
inline

A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

Definition at line 309 of file GameSessionConnectionInfo.h.

◆ WithMatchedPlayerSessions() [2/2]

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithMatchedPlayerSessions ( const Aws::Vector< MatchedPlayerSession > &  value)
inline

A collection of player session IDs, one for each player ID that was included in the original matchmaking request.

Definition at line 303 of file GameSessionConnectionInfo.h.

◆ WithPort()

GameSessionConnectionInfo& Aws::GameLift::Model::GameSessionConnectionInfo::WithPort ( int  value)
inline

The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.

Definition at line 272 of file GameSessionConnectionInfo.h.


The documentation for this class was generated from the following file: