Farm

Server.Modules. Farm

# new Farm(coreObj) → {Server.Modules.Farm}

This is the Farm Module of the Blackrock Application Server. It provides distributed / cluster compute capabilities for the server, allowing you to run multiple disparate instances of the server (that can be geographically disbursed) in unison. It uses the Scuttlebutt Gossip Protocol to share state across all nodes in the cluster. PLEASE NOTE: This interface is undergoing development and is not yet functional.

Parameters:
Name Type Description
coreObj Server.Modules.Core

The Parent Core Object

Author:
  • Darren Smith
License:
  • Licensed under the LGPL license.
Returns:

module - The Farm Module

Type
Server.Modules.Farm
Example
Tbc...

Extends

Methods

# (static) get(key) → {*}

Tbc...

Parameters:
Name Type Description
key string

Lookup Key

Returns:

result - Lookup Value

Type
*
Example
Tbc...

# (static) isJobServer() → {boolean}

Tbc...

Returns:

result - Is Job Server Result (True | False)

Type
boolean
Example
Tbc...

# (static) set(key, value) → {*}

Tbc...

Parameters:
Name Type Description
key string

Lookup Key

value *

Value to Set

Returns:

result - Result

Type
*
Example
Tbc...

# (static) updateListener(fn) → {*}

Tbc...

Parameters:
Name Type Description
fn function

Callback For Listener

Returns:

result - Lookup Value

Type
*
Example
Tbc...