Package com.ultikits.ultitools.websocket

Interface CloudPlayerLinks.Transport

All Known Implementing Classes:

PlayerLinkChannel

Enclosing class:

CloudPlayerLinks

@Internal
public static interface CloudPlayerLinks.Transport

The framework's transport for link messages; internal, not for module use.

Modules pass an implementation to CloudPlayerLinks only through the framework's accessor; a module test may implement or mock it to exercise its own code.

Since:

6.3.1

Method Summary

Modifier and Type	Method	Description
CompletableFuture<CloudPlayerLinks.LinkCreation>	create(UltiToolsPlugin requester, UUID playerUuid, String playerName, CloudPlayerLinks.GameAuth gameAuth, Set<CloudPlayerLinks.LinkProof> offeredProofs)	Sends one player.link.create and tracks its answer.
void	removeHandler(UltiToolsPlugin owner)	Removes the handler if owner set it.
void	setHandler(UltiToolsPlugin owner, CloudPlayerLinks.LinkEventHandler handler)	Installs the single-owner handler.

Method Details

create

CompletableFuture<CloudPlayerLinks.LinkCreation> create(UltiToolsPlugin requester,
 UUID playerUuid,
 String playerName,
 CloudPlayerLinks.GameAuth gameAuth,
 Set<CloudPlayerLinks.LinkProof> offeredProofs)

Sends one player.link.create and tracks its answer.

Parameters:

requester - the calling module

playerUuid - the player's UUID

playerName - the player's name

gameAuth - the game-authentication facts

offeredProofs - the supported proofs

Returns:

the answer future, never null

setHandler

void setHandler(UltiToolsPlugin owner,
 CloudPlayerLinks.LinkEventHandler handler)

Installs the single-owner handler.

Parameters:

owner - the owning module

handler - the handler

Throws:

IllegalStateException - if another module owns the handler

removeHandler

void removeHandler(UltiToolsPlugin owner)

Removes the handler if owner set it.

Parameters:

owner - the owning module