Package dev.getelements.elements.sdk.dao

Interface Matchmaker

All Known Implementing Classes:

MongoFIFOMatchmaker

public interface Matchmaker

Created by patricktwohig on 7/27/17.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Matchmaker.Factory	Supplies a Matchmaker based on the algorithm.
static interface	Matchmaker.SuccessfulMatchTuple	Combines a Match for both a player and an opponent.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAX_CANDIDATES

Method Summary

Modifier and Type	Method	Description
Matchmaker.SuccessfulMatchTuple	attemptToFindOpponent(Match match, int maxCandidatesToConsider, BiFunction<Match,Match,String> finalizer)	Attempts to find an opponent for the supplied Match instance.
default Matchmaker.SuccessfulMatchTuple	attemptToFindOpponent(Match match, BiFunction<Match,Match,String> finalizer)	Invokes attemptToFindOpponent(Match, int, BiFunction<Match, Match, String>) using the DEFAULT_MAX_CANDIDATES value.
MatchingAlgorithm	getAlgorithm()	Returns the MatchingAlgorithm implemented by this matchmaker.
Matchmaker	withScope(String scope)	Restricts this Matchmaker to the supplied scope.

Field Details

DEFAULT_MAX_CANDIDATES

static final int DEFAULT_MAX_CANDIDATES

See Also:

• Constant Field Values

Method Details

getAlgorithm

MatchingAlgorithm getAlgorithm()

Returns the MatchingAlgorithm implemented by this matchmaker.

Returns:

the MatchingAlgorithm

attemptToFindOpponent

default Matchmaker.SuccessfulMatchTuple attemptToFindOpponent(Match match,
 BiFunction<Match,Match,String> finalizer)
                                                       throws NoSuitableMatchException

Invokes attemptToFindOpponent(Match, int, BiFunction<Match, Match, String>) using the DEFAULT_MAX_CANDIDATES value.

Parameters:

match - the Match to use

Returns:

a Matchmaker.SuccessfulMatchTuple representing a successful match, never null

Throws:

NoSuitableMatchException - if there is no suitable match found

attemptToFindOpponent

Matchmaker.SuccessfulMatchTuple attemptToFindOpponent(Match match,
 int maxCandidatesToConsider,
 BiFunction<Match,Match,String> finalizer)
                                               throws NoSuitableMatchException

Attempts to find an opponent for the supplied Match instance. This will query the database for suitable matches. This will return a Matchmaker.SuccessfulMatchTuple combining the match of the player and the opponent's match.

Thia also finalizes the matching process by flagging the Match instances for deletion and invoking the finalizer Supplier<String>. The supplied Supplier<String> returns a system-wide unique ID used to process to identify the game that was created as the result of the Match. The return value of this method will be assigned to the match using Match.setGameId(String).

Note that this method guarantees that the supplied Supplier<String> finalizer will only ever be called once per successful matching tuple as multiple players may attempt to finalize the pairing at the same time. The return value indicates the affected Match instances, or returns an emnpty stream if no Match instances were affected by the finalization.

Because both players may not have read the Match, the involved Match instances will be marked for timeout and deletion at a later time.

Parameters:

match - the Match the player match

maxCandidatesToConsider - the maximum number of candidates to consider

finalizer - the Supplier used to finalize the match and provide the resulting game id

Returns:

a Matchmaker.SuccessfulMatchTuple representing a successful match, never null

Throws:

NoSuitableMatchException - if there is no suitable match found

withScope

Matchmaker withScope(String scope)

Restricts this Matchmaker to the supplied scope. Will return only whose Match.getScope() method matches the supplied scope. Unscoped Match instances will also be excluded from the candidate pool.

Parameters:

scope - the scope

Returns:

this instance