me.lucko.helper.network

Interface Network

All Superinterfaces:

AutoCloseable, Terminable

All Known Implementing Classes:

AbstractNetwork

public interface Network
extends Terminable

Represents the interface for a network.

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
void	close() Closes this resource.
static Network	create(Messenger messenger, InstanceData instanceData) Creates a new Network instance.
net.kyori.event.EventBus<NetworkEvent>	getEventBus() Gets the network event bus.
Map<UUID,Profile>	getOnlinePlayers() Gets the players known to be online in the network.
int	getOverallPlayerCount() Gets the overall player count
Map<String,Server>	getServers() Gets the known servers in the network
static Network	obtain(Supplier<Network> ifElse) Tries to obtain an instance of network from the services manager, falling back to given supplier if one is not already present.
void	registerMetadataProvider(ServerMetadataProvider metadataProvider) Registers a metadata provider for this server with the network.

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, closeAndReportException, closeSilently, isClosed

Method Detail

create

static Network create(Messenger messenger,
                      InstanceData instanceData)

Creates a new Network instance. These should be shared if possible.

Parameters:

messenger - the messenger

instanceData - the instance data

Returns:

the new network

obtain

static Network obtain(Supplier<Network> ifElse)

Tries to obtain an instance of network from the services manager, falling back to given supplier if one is not already present.

Parameters:

ifElse - the supplier

Returns:

the network instance

getServers

Map<String,Server> getServers()

Gets the known servers in the network

Returns:

the known servers

getOnlinePlayers

Map<UUID,Profile> getOnlinePlayers()

Gets the players known to be online in the network.

Returns:

the known online players

getOverallPlayerCount

int getOverallPlayerCount()

Gets the overall player count

Returns:

the player count

registerMetadataProvider

void registerMetadataProvider(ServerMetadataProvider metadataProvider)

Registers a metadata provider for this server with the network.

Parameters:

metadataProvider - the provider

getEventBus

net.kyori.event.EventBus<NetworkEvent> getEventBus()

Gets the network event bus.

Returns:

the event bus

close

void close()

Description copied from interface: Terminable

Closes this resource.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Terminable