AWS SDK for C++  1.9.66
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 an executable in a custom game build or a Realtime Servers script. Server process configurations are part of a fleet's RuntimeConfiguration.

See Also:

AWS API Reference

Definition at line 34 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

The number of server processes using this configuration that run concurrently on each instance.

Definition at line 191 of file ServerProcess.h.

◆ GetConcurrentExecutions()

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

The number of server processes using this configuration that run concurrently on each instance.

Definition at line 185 of file ServerProcess.h.

◆ GetLaunchPath()

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

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

  • Windows (custom game builds only): C:\game. 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 52 of file ServerProcess.h.

◆ GetParameters()

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

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

Definition at line 136 of file ServerProcess.h.

◆ Jsonize()

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

◆ LaunchPathHasBeenSet()

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

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

  • Windows (custom game builds only): C:\game. 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 63 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

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

Definition at line 142 of file ServerProcess.h.

◆ SetConcurrentExecutions()

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

The number of server processes using this configuration that run concurrently on each instance.

Definition at line 197 of file ServerProcess.h.

◆ SetLaunchPath() [1/3]

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

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

  • Windows (custom game builds only): C:\game. 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 85 of file ServerProcess.h.

◆ SetLaunchPath() [2/3]

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

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

  • Windows (custom game builds only): C:\game. 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 74 of file ServerProcess.h.

◆ SetLaunchPath() [3/3]

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

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

  • Windows (custom game builds only): C:\game. 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 96 of file ServerProcess.h.

◆ SetParameters() [1/3]

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

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

Definition at line 154 of file ServerProcess.h.

◆ SetParameters() [2/3]

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

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

Definition at line 148 of file ServerProcess.h.

◆ SetParameters() [3/3]

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

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

Definition at line 160 of file ServerProcess.h.

◆ WithConcurrentExecutions()

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

The number of server processes using this configuration that run concurrently on each instance.

Definition at line 203 of file ServerProcess.h.

◆ WithLaunchPath() [1/3]

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

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

  • Windows (custom game builds only): C:\game. 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 118 of file ServerProcess.h.

◆ WithLaunchPath() [2/3]

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

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

  • Windows (custom game builds only): C:\game. 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 107 of file ServerProcess.h.

◆ WithLaunchPath() [3/3]

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

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

  • Windows (custom game builds only): C:\game. 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 129 of file ServerProcess.h.

◆ WithParameters() [1/3]

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

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

Definition at line 172 of file ServerProcess.h.

◆ WithParameters() [2/3]

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

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

Definition at line 166 of file ServerProcess.h.

◆ WithParameters() [3/3]

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

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

Definition at line 178 of file ServerProcess.h.


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