evaluator

Documentation

Overview

Package evaluator provides the Evaluator service for Open Match golang harness.

Package evaluator provides the Evaluator service for Open Match golang harness.

Index

• func BindService(p *rpc.ServerParams, cfg config.View, eval Evaluator) error
• func RunEvaluator(eval Evaluator)
• type Evaluator
• type Params

Functions

func BindService

func BindService(p *rpc.ServerParams, cfg config.View, eval Evaluator) error

BindService creates the evaluator service to the server Params.

func RunEvaluator

func RunEvaluator(eval Evaluator)

RunEvaluator is a hook for the main() method in the main executable.

Types

type Evaluator

type Evaluator func(*Params) ([]string, error)

Evaluator is the function signature for the Evaluator to be implemented by the user. The harness will pass the Matches to evaluate to the Evaluator and the Evaluator will return an accepted list of Matches.

type Params

type Params struct {
	Logger  *logrus.Entry
	Matches []*pb.Match
}

Params is the parameters to be passed by the harness to the evaluator.

• logger: A logger used to generate error/debug logs
• Matches Matches to be evaluated