Represents a collection of server instances which can be accessed randomly based on their current lod level. More...

Public Member Functions
	LoadBalancer ()
	Initializes a new instance of the LoadBalancer<TServer> class. Use default weights for each load level. More...

	LoadBalancer (string configFilePath)
	Initializes a new instance of the LoadBalancer<TServer> class. More...

	LoadBalancer (int[] loadLevelWeights)
	Initializes a new instance of the LoadBalancer<TServer> class. More...

	LoadBalancer (int[] loadLevelWeights, int seed)
	Initializes a new instance of the LoadBalancer<TServer> class. More...

bool	TryAddServer (TServer server, FeedbackLevel loadLevel)
	Attempts to add a server instance. More...

bool	TryGetServer (out TServer server)
	Tries to get a free server instance. More...

bool	TryGetServer (out TServer server, out FeedbackLevel loadLevel)
	Tries to get a free server instance. More...

bool	TryRemoveServer (TServer server)
	Tries to remove a server instance. More...

bool	TryUpdateServer (TServer server, FeedbackLevel newLoadLevel)
	Tries to update a server instance. More...

void	DumpState ()

Properties
FeedbackLevel	AverageWorkload `[get]`
	Gets the average workload of all server instances. More...

bool	HasAvailableServers `[get]`

int	TotalWorkload `[get]`

int	TotalWeight `[get]`

Detailed Description

Represents a collection of server instances which can be accessed randomly based on their current lod level.

Template Parameters

TServer The type of the server instances.

Each server instance gets a weight assigned based on the current load level of that server. The TryGetServer method gets a random server based on this weight. A server with a higher weight will be returned more often than a server with a lower weight. The default values for this weights are the following:

LoadLevel.Lowest = 40 LoadLevel.Low = 30 LoadLevel.Normal = 20 LoadLevel.High = 10 LoadLevel.Highest = 0

If there is for example one server for eac load level, the server with load level lowest will be returned 50% of the times, the one with load level low 30% and so on.

Constructor & Destructor Documentation

◆ LoadBalancer() [1/4]

Photon.Common.LoadBalancer.LoadBalancer< TServer >.LoadBalancer ( )

inline

Initializes a new instance of the LoadBalancer<TServer> class. Use default weights for each load level.

◆ LoadBalancer() [2/4]

Photon.Common.LoadBalancer.LoadBalancer< TServer >.LoadBalancer ( string configFilePath )

inline

Initializes a new instance of the LoadBalancer<TServer> class.

Parameters

configFilePath The full path (absolute or relative) to a config file that specifies a Weight for each LoadLevel. The possible load levels and their values are defined int the FeedbackLevel enumeration. See the LoadBalancing.config for an example.

◆ LoadBalancer() [3/4]

Photon.Common.LoadBalancer.LoadBalancer< TServer >.LoadBalancer ( int[] loadLevelWeights )

inline

Initializes a new instance of the LoadBalancer<TServer> class.

Parameters

loadLevelWeights A list of weights which should be used for each available load level. This list must contain a value for each available load level and must be ordered by the load levels value. The possible load levels and their values are defined int the FeedbackLevel enumeration.

◆ LoadBalancer() [4/4]

Photon.Common.LoadBalancer.LoadBalancer< TServer >.LoadBalancer	(	int[]	loadLevelWeights,
		int	seed
	)

inline

Initializes a new instance of the LoadBalancer<TServer> class.

This overload is used for unit testing to provide a fixed seed for the random number generator.

Member Function Documentation

◆ DumpState()

void Photon.Common.LoadBalancer.LoadBalancer< TServer >.DumpState ( )

inline

◆ TryAddServer()

bool Photon.Common.LoadBalancer.LoadBalancer< TServer >.TryAddServer	(	TServer	server,
		FeedbackLevel	loadLevel
	)

inline

Attempts to add a server instance.

Parameters

server	The server instance to add.
loadLevel	The current workload of the server instance.

Returns: True if the server instance was added successfully. If the server instance already exists, this method returns false.

◆ TryGetServer() [1/2]

bool Photon.Common.LoadBalancer.LoadBalancer< TServer >.TryGetServer ( out TServer server )

inline

Tries to get a free server instance.

Parameters

server When this method returns, contains an available server instance or null if no available server instances exists.

Returns: True if a server instance with enough remaining workload is found; otherwise false.

◆ TryGetServer() [2/2]

bool Photon.Common.LoadBalancer.LoadBalancer< TServer >.TryGetServer	(	out TServer	server,
		out FeedbackLevel	loadLevel
	)

inline

Tries to get a free server instance.

Parameters

server	When this method returns, contains the server instance with the fewest workload or null if no server instances exists.
loadLevel	When this method returns, contains an available server instance or null if no available server instances exists.

Returns: True if a server instance with enough remaining workload is found; otherwise false.

◆ TryRemoveServer()

bool Photon.Common.LoadBalancer.LoadBalancer< TServer >.TryRemoveServer ( TServer server )

inline

Tries to remove a server instance.

Parameters

server The server instance to remove.

Returns: True if the server instance was removed successfully. If the server instance does not exists, this method returns false.

◆ TryUpdateServer()

bool Photon.Common.LoadBalancer.LoadBalancer< TServer >.TryUpdateServer	(	TServer	server,
		FeedbackLevel	newLoadLevel
	)

inline

Tries to update a server instance.

Parameters

server	The server to update.
newLoadLevel	The current workload of the server instance.

Returns: True if the server instance was updated successfully. If the server instance does not exists, this method returns false.

Property Documentation

◆ AverageWorkload

FeedbackLevel Photon.Common.LoadBalancer.LoadBalancer< TServer >.AverageWorkload

get

Gets the average workload of all server instances.

◆ HasAvailableServers

bool Photon.Common.LoadBalancer.LoadBalancer< TServer >.HasAvailableServers

get

◆ TotalWeight

int Photon.Common.LoadBalancer.LoadBalancer< TServer >.TotalWeight

get

◆ TotalWorkload

int Photon.Common.LoadBalancer.LoadBalancer< TServer >.TotalWorkload

get

Photon Server API

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ LoadBalancer() [1/4]

◆ LoadBalancer() [2/4]

◆ LoadBalancer() [3/4]

◆ LoadBalancer() [4/4]

Member Function Documentation

◆ DumpState()

◆ TryAddServer()

◆ TryGetServer() [1/2]

◆ TryGetServer() [2/2]

◆ TryRemoveServer()

◆ TryUpdateServer()

Property Documentation

◆ AverageWorkload

◆ HasAvailableServers

◆ TotalWeight

◆ TotalWorkload