MatchEngine | dimensions-ai

The Match Engine that takes a Design and its specified EngineOptions to form the backend for running matches with agents.

Hierarchy

MatchEngine

Index

Enumerations

Interfaces

Constructors

constructor

Properties

Methods

Constructors

constructor

new MatchEngine(design: Design, loggingLevel: LEVEL): MatchEngine

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L64
Match engine constructor

Parameters
- design: Design
  
  the design to use
- loggingLevel: LEVEL
  
  the logging level for this engine
Returns MatchEngine

Properties

Private design

design: Design

The design the engine runs on

Private docker

docker: Dockerode

Private engineOptions

engineOptions: EngineOptions = deepCopy(DefaultMatchEngineOptions)

Engine options

killOffSignal

killOffSignal: boolean = false

A coordination signal to ensure that all processes are indeed killed due to asynchronous initialization of agents There is a race condition when a tournament/match is being destroyed and while every match is being destroyed, some matches are in the initialization stage where they call the engine's initialize function. As a result, when we send a match destroy signal, we spawn some processes and haven't spawned some others for the agents. As a result, all processes eventually get spawned but not all are cleaned up and killed.

Private log

log: Logger = new Logger()

Logger

Private memoryWatchInterval

memoryWatchInterval: any = null

Single memory watch interval so that all memory checks are made together

Private overrideOptions

overrideOptions: OverrideOptions

Override options

Static timeoutBuffer

timeoutBuffer: number = 25

approx extra buffer time given to agents due to engine processing for timeout mechanism

Methods

getCommands

getCommands(match: Match): Promise<Array<Command>>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L466
Returns a promise that resolves with all the commands loaded from the previous time step of the provided match This coordinates all the Agents and waits for each one to finish their step

Parameters
- match: Match
  
  The match to get commands from agents for
Returns Promise<Array<Command>>

a promise that resolves with an array of MatchEngine.Command elements, holding the command and id of the agent that sent it

getEngineOptions

getEngineOptions(): EngineOptions

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L88
Get the engine options

Returns EngineOptions

getLogger

getLogger(): Logger

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L758
Returns the logger for this match engine

Returns Logger

Private handleCommand

handleCommand(agent: Agent, str: string): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L344
Handles partial stdout from an agent

Parameters
- agent: Agent
  
  the agent to process the command for
- str: string
  
  the string the agent sent
Returns Promise<void>

initialize

initialize(agents: Array<Agent>, match: Match): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L102
Starts up the engine by intializing processes for all the agents and setting some variables for a match

Parameters
- agents: Array<Agent>
  
  The agents involved to be setup for the given match
- match: Match
  
  The match to initialize
Returns Promise<void>

a promise that resolves once succesfully initialized

Private initializeAgent

initializeAgent(agent: Agent, match: Match): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L122
Initializes a single agent, called by initialize

Parameters
- agent: Agent
  
  agent to initialize
- match: Match
  
  match to initialize in
Returns Promise<void>

initializeCustom

initializeCustom(): Promise<boolean>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L547
Returns Promise<boolean>

kill

kill(agent: Agent, reason?: string): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L446
Kills an agent and closes the process, and no longer attempts to receive coommands from it anymore

Parameters
- agent: Agent
  
  the agent to kill off
- Default value reason: string = "unspecified"
Returns Promise<void>

killAndClean

killAndClean(match: Match): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L429
Kills all intervals and agents and processes from a match and cleans up. Kills any game processes as well. Shouldn't be used for custom design based matches. Called by Match

Parameters
- match: Match
  
  the match to kill all agents in and clean up
Returns Promise<void>

killAndCleanCustom

killAndCleanCustom(match: Match): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L693
Attempts to kill and clean up anything else for a custom design based match

Parameters
- match: Match
  
  the match to kill and clean up
Returns Promise<void>

Private parseCustomArguments

parseCustomArguments(match: Match, args: Array<string | DynamicDataStrings>): Array<string>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L702
Parses a list of arguments for a given match and populates relevant strings as needed

Parameters
- match: Match
  
  the match to parse arguments for
- args: Array<string | DynamicDataStrings>
  
  the arguments to parse
Returns Array<string>

resume

resume(match: Match): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L414
Attempts to gracefully and synchronously resume a previously stopped match

Parameters
- match: Match
  
  the match to resume
Returns Promise<void>

resumeCustom

resumeCustom(match: Match): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L684
Attempts to resume a Match based on a custom Design

Parameters
- match: Match
  
  the match to resume
Returns Promise<void>

runCustom

runCustom(match: Match): Promise<Array<string>>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L559
Run a custom match. A custom match much print to stdout all relevant data to be used by the engine and Dimensions framework. All output after the conclude command from Design.OverrideOptions is outputted is stored as a list of new line delimited strings and returned as the match results. The match must exit with exit code 0 to be marked as succesfully complete and the processing of results stops and this function resolves

Parameters
- match: Match
  
  the match to run
Returns Promise<Array<string>>

send

send(match: Match, message: string, agentID: ID): Promise<boolean>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L511
Sends a message to a particular process governed by an agent in a specified match specified by the agentID

Parameters
- match: Match
  
  the match to work with
- message: string
  
  the message to send to agent's stdin
- agentID: ID
  
  id that specifies the agent in the match to send the message to
Returns Promise<boolean>

setEngineOptions

setEngineOptions(newOptions?: DeepPartial<EngineOptions>): void

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L92
Set the engine options

Parameters
- Default value newOptions: DeepPartial<EngineOptions> = {}
Returns void

setLogLevel

setLogLevel(loggingLevel: LEVEL): void

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L84
Set log level

Parameters
- loggingLevel: LEVEL
Returns void

stop

stop(match: Match): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L401
Attempts to gracefully and synchronously stop a match's agents

Parameters
- match: Match
  
  the match to stop
Returns Promise<void>

stopCustom

stopCustom(match: Match): Promise<void>

- Defined in https://github.com/StoneT2000/Dimensions/blob/master/src/MatchEngine/index.ts#L674
Attempts to stop a Match based on a custom Design

Parameters
- match: Match
  
  the match to stop
Returns Promise<void>

Hierarchy

Index

Enumerations

Interfaces

Constructors

Properties

Methods

Constructors

constructor

Parameters

design: Design

loggingLevel: LEVEL

Returns MatchEngine

Properties

Private design

Private docker

Private engineOptions

killOffSignal

Private log

Private memoryWatchInterval

Private overrideOptions

Static timeoutBuffer

Methods

getCommands

Parameters

match: Match

Returns Promise<Array<Command>>

getEngineOptions

Returns EngineOptions

getLogger

Returns Logger

Private handleCommand

Parameters

agent: Agent

str: string

Returns Promise<void>

initialize

Parameters

agents: Array<Agent>

match: Match

Returns Promise<void>

Private initializeAgent

Parameters

agent: Agent

match: Match

Returns Promise<void>

initializeCustom

Returns Promise<boolean>

kill

Parameters

agent: Agent

Default value reason: string = "unspecified"

Returns Promise<void>

killAndClean

Parameters

match: Match

Returns Promise<void>

killAndCleanCustom

Parameters

match: Match

Returns Promise<void>

Private parseCustomArguments

Parameters

match: Match

args: Array<string | DynamicDataStrings>

Returns Array<string>

resume

Parameters

match: Match

Returns Promise<void>

resumeCustom

Parameters

match: Match

Returns Promise<void>

runCustom

Parameters

match: Match

Returns Promise<Array<string>>

send

Parameters