Package dev.getelements.elements.dao.mongo.match

Class MongoMatchUtils

java.lang.Object

dev.getelements.elements.dao.mongo.match.MongoMatchUtils

public class MongoMatchUtils
extends Object

Used to actually perform the match between two players. This ensures that two matches are made with consistency and all appropriate diffs are created. Created by patricktwohig on 7/27/17.

Constructor Summary

Constructors

Constructor	Description
MongoMatchUtils()

Method Summary

Modifier and Type	Method	Description
<T> T	attemptLock(jakarta.inject.Provider<T> resultProvider, MongoMatch... mongoMatches)	Intended to be used in the scope of MongoConcurrentUtils.performOptimistic(MongoConcurrentUtils.CriticalOperation), this will attempt to lock the MongoMatch using a unique MongoMatchLock.
Matchmaker.SuccessfulMatchTuple	attemptToPairCandidates(MongoMatch playerMatch, MongoMatch opponentMatch, BiFunction<Match,Match,String> finalizer)	Attempts to pair the two matches in the database.
Matchmaker.SuccessfulMatchTuple	attemptToPairCandidates(MongoMatch playerMatch, List<MongoMatch> candidatesList, BiFunction<Match,Match,String> finalizer)
dev.morphia.Datastore	getDatastore()
MapperRegistry	getDozerMapper()
MongoDBUtils	getMongoDBUtils()
void	setDatastore(dev.morphia.Datastore datastore)
void	setDozerMapper(MapperRegistry dozerMapperRegistry)
void	setMongoDBUtils(MongoDBUtils mongoDBUtils)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MongoMatchUtils

public MongoMatchUtils()

Method Details

attemptLock

public <T> T attemptLock(jakarta.inject.Provider<T> resultProvider,
 MongoMatch... mongoMatches)
                  throws MongoConcurrentUtils.ContentionException

Intended to be used in the scope of MongoConcurrentUtils.performOptimistic(MongoConcurrentUtils.CriticalOperation), this will attempt to lock the MongoMatch using a unique MongoMatchLock. If successful, this will perform the operation defined by the supplied jakarta.inject.Provider<T> instance. If the lock fails, then this will throw an instance of MongoConcurrentUtils.ContentionException to indicate that a re-lock must be attempted or the process abandoned by the calling code. This is necessary because matching may happen at any time which involves controlling access to multiple documents. Therefore code which mutates or deletes a MongoMatch should only be done within the context of a lock. This allows for acquiring multiple MongoMatchLock instances and safely unlocking them even if the code specified in the jakarta.inject.Provider<T>fails to execute.

Type Parameters:

T - the return type

Parameters:

resultProvider - the jakarta.inject.Provider<T> defining the operation to perform

mongoMatches - one or MongoMatch instances to return

Returns:

the value returned by the supplied provider

Throws:

MongoConcurrentUtils.ContentionException - if locking fails

attemptToPairCandidates

public Matchmaker.SuccessfulMatchTuple attemptToPairCandidates(MongoMatch playerMatch,
 List<MongoMatch> candidatesList,
 BiFunction<Match,Match,String> finalizer)
                                                        throws NoSuitableMatchException

Throws:

NoSuitableMatchException

attemptToPairCandidates

public Matchmaker.SuccessfulMatchTuple attemptToPairCandidates(MongoMatch playerMatch,
 MongoMatch opponentMatch,
 BiFunction<Match,Match,String> finalizer)
                                                        throws NoSuitableMatchException

Attempts to pair the two matches in the database. If this succeeds, an instance of Matchmaker.SuccessfulMatchTuple will be returned. If not an instance of NoSuitableMatchException will be thrown.

Parameters:

playerMatch - the player to match to the opponent

opponentMatch - the opponent to match to the player

Returns:

an instance of Matchmaker.SuccessfulMatchTuple complete with delta log

Throws:

NoSuitableMatchException - if the matching fails

getDatastore

public dev.morphia.Datastore getDatastore()

setDatastore

@Inject
public void setDatastore(dev.morphia.Datastore datastore)

getDozerMapper

public MapperRegistry getDozerMapper()

setDozerMapper

@Inject
public void setDozerMapper(MapperRegistry dozerMapperRegistry)

getMongoDBUtils

public MongoDBUtils getMongoDBUtils()

setMongoDBUtils

@Inject
public void setMongoDBUtils(MongoDBUtils mongoDBUtils)