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

#include <ServerProcess.h>

Public Member Functions

 ServerProcess ()
 
 ServerProcess (Aws::Utils::Json::JsonView jsonValue)
 
ServerProcessoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetLaunchPath () const
 
bool LaunchPathHasBeenSet () const
 
void SetLaunchPath (const Aws::String &value)
 
void SetLaunchPath (Aws::String &&value)
 
void SetLaunchPath (const char *value)
 
ServerProcessWithLaunchPath (const Aws::String &value)
 
ServerProcessWithLaunchPath (Aws::String &&value)
 
ServerProcessWithLaunchPath (const char *value)
 
const Aws::StringGetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::String &value)
 
void SetParameters (Aws::String &&value)
 
void SetParameters (const char *value)
 
ServerProcessWithParameters (const Aws::String &value)
 
ServerProcessWithParameters (Aws::String &&value)
 
ServerProcessWithParameters (const char *value)
 
int GetConcurrentExecutions () const
 
bool ConcurrentExecutionsHasBeenSet () const
 
void SetConcurrentExecutions (int value)
 
ServerProcessWithConcurrentExecutions (int value)
 

Detailed Description

A set of instructions for launching server processes on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instruction set identifies the location of the custom game build executable or Realtime launch script, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration .

See Also:

AWS API Reference

Definition at line 47 of file ServerProcess.h.

Constructor & Destructor Documentation

◆ ServerProcess() [1/2]

Aws::GameLift::Model::ServerProcess::ServerProcess ( )

◆ ServerProcess() [2/2]

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

Member Function Documentation

◆ ConcurrentExecutionsHasBeenSet()

bool Aws::GameLift::Model::ServerProcess::ConcurrentExecutionsHasBeenSet ( ) const
inline

Number of server processes using this configuration to run concurrently on an instance.

Definition at line 204 of file ServerProcess.h.

◆ GetConcurrentExecutions()

int Aws::GameLift::Model::ServerProcess::GetConcurrentExecutions ( ) const
inline

Number of server processes using this configuration to run concurrently on an instance.

Definition at line 198 of file ServerProcess.h.

◆ GetLaunchPath()

const Aws::String& Aws::GameLift::Model::ServerProcess::GetLaunchPath ( ) const
inline

Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for custom game builds only): C:. Example: "<code>C:\game\MyGame\server.exe</code>"

  • Linux: /local/game. Examples: "<code>/local/game/MyGame/server.exe</code>" or "<code>/local/game/MyRealtimeScript.js</code>"

Definition at line 65 of file ServerProcess.h.

◆ GetParameters()

const Aws::String& Aws::GameLift::Model::ServerProcess::GetParameters ( ) const
inline

Optional list of parameters to pass to the server executable or Realtime script on launch.

Definition at line 149 of file ServerProcess.h.

◆ Jsonize()

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

◆ LaunchPathHasBeenSet()

bool Aws::GameLift::Model::ServerProcess::LaunchPathHasBeenSet ( ) const
inline

Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for custom game builds only): C:. Example: "<code>C:\game\MyGame\server.exe</code>"

  • Linux: /local/game. Examples: "<code>/local/game/MyGame/server.exe</code>" or "<code>/local/game/MyRealtimeScript.js</code>"

Definition at line 76 of file ServerProcess.h.

◆ operator=()

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

◆ ParametersHasBeenSet()

bool Aws::GameLift::Model::ServerProcess::ParametersHasBeenSet ( ) const
inline

Optional list of parameters to pass to the server executable or Realtime script on launch.

Definition at line 155 of file ServerProcess.h.

◆ SetConcurrentExecutions()

void Aws::GameLift::Model::ServerProcess::SetConcurrentExecutions ( int  value)
inline

Number of server processes using this configuration to run concurrently on an instance.

Definition at line 210 of file ServerProcess.h.

◆ SetLaunchPath() [1/3]

void Aws::GameLift::Model::ServerProcess::SetLaunchPath ( const Aws::String value)
inline

Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for custom game builds only): C:. Example: "<code>C:\game\MyGame\server.exe</code>"

  • Linux: /local/game. Examples: "<code>/local/game/MyGame/server.exe</code>" or "<code>/local/game/MyRealtimeScript.js</code>"

Definition at line 87 of file ServerProcess.h.

◆ SetLaunchPath() [2/3]

void Aws::GameLift::Model::ServerProcess::SetLaunchPath ( Aws::String &&  value)
inline

Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for custom game builds only): C:. Example: "<code>C:\game\MyGame\server.exe</code>"

  • Linux: /local/game. Examples: "<code>/local/game/MyGame/server.exe</code>" or "<code>/local/game/MyRealtimeScript.js</code>"

Definition at line 98 of file ServerProcess.h.

◆ SetLaunchPath() [3/3]

void Aws::GameLift::Model::ServerProcess::SetLaunchPath ( const char *  value)
inline

Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for custom game builds only): C:. Example: "<code>C:\game\MyGame\server.exe</code>"

  • Linux: /local/game. Examples: "<code>/local/game/MyGame/server.exe</code>" or "<code>/local/game/MyRealtimeScript.js</code>"

Definition at line 109 of file ServerProcess.h.

◆ SetParameters() [1/3]

void Aws::GameLift::Model::ServerProcess::SetParameters ( const Aws::String value)
inline

Optional list of parameters to pass to the server executable or Realtime script on launch.

Definition at line 161 of file ServerProcess.h.

◆ SetParameters() [2/3]

void Aws::GameLift::Model::ServerProcess::SetParameters ( Aws::String &&  value)
inline

Optional list of parameters to pass to the server executable or Realtime script on launch.

Definition at line 167 of file ServerProcess.h.

◆ SetParameters() [3/3]

void Aws::GameLift::Model::ServerProcess::SetParameters ( const char *  value)
inline

Optional list of parameters to pass to the server executable or Realtime script on launch.

Definition at line 173 of file ServerProcess.h.

◆ WithConcurrentExecutions()

ServerProcess& Aws::GameLift::Model::ServerProcess::WithConcurrentExecutions ( int  value)
inline

Number of server processes using this configuration to run concurrently on an instance.

Definition at line 216 of file ServerProcess.h.

◆ WithLaunchPath() [1/3]

ServerProcess& Aws::GameLift::Model::ServerProcess::WithLaunchPath ( const Aws::String value)
inline

Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for custom game builds only): C:. Example: "<code>C:\game\MyGame\server.exe</code>"

  • Linux: /local/game. Examples: "<code>/local/game/MyGame/server.exe</code>" or "<code>/local/game/MyRealtimeScript.js</code>"

Definition at line 120 of file ServerProcess.h.

◆ WithLaunchPath() [2/3]

ServerProcess& Aws::GameLift::Model::ServerProcess::WithLaunchPath ( Aws::String &&  value)
inline

Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for custom game builds only): C:. Example: "<code>C:\game\MyGame\server.exe</code>"

  • Linux: /local/game. Examples: "<code>/local/game/MyGame/server.exe</code>" or "<code>/local/game/MyRealtimeScript.js</code>"

Definition at line 131 of file ServerProcess.h.

◆ WithLaunchPath() [3/3]

ServerProcess& Aws::GameLift::Model::ServerProcess::WithLaunchPath ( const char *  value)
inline

Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for custom game builds only): C:. Example: "<code>C:\game\MyGame\server.exe</code>"

  • Linux: /local/game. Examples: "<code>/local/game/MyGame/server.exe</code>" or "<code>/local/game/MyRealtimeScript.js</code>"

Definition at line 142 of file ServerProcess.h.

◆ WithParameters() [1/3]

ServerProcess& Aws::GameLift::Model::ServerProcess::WithParameters ( const Aws::String value)
inline

Optional list of parameters to pass to the server executable or Realtime script on launch.

Definition at line 179 of file ServerProcess.h.

◆ WithParameters() [2/3]

ServerProcess& Aws::GameLift::Model::ServerProcess::WithParameters ( Aws::String &&  value)
inline

Optional list of parameters to pass to the server executable or Realtime script on launch.

Definition at line 185 of file ServerProcess.h.

◆ WithParameters() [3/3]

ServerProcess& Aws::GameLift::Model::ServerProcess::WithParameters ( const char *  value)
inline

Optional list of parameters to pass to the server executable or Realtime script on launch.

Definition at line 191 of file ServerProcess.h.


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