ml.karmaconfigs.remote.messaging

Class Server

java.lang.Object

ml.karmaconfigs.remote.messaging.Server

All Implemented Interfaces:

Serializable, ml.karmaconfigs.api.common.karma.KarmaSource

Direct Known Subclasses:

TCPServer

public abstract class Server
extends Object
implements ml.karmaconfigs.api.common.karma.KarmaSource

Remote message server interface

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Server()

Method Summary

Modifier and Type	Method and Description
abstract void	ban(String... macAddresses) Ban an address from the server
abstract void	broadcast(MessageOutput data) Send a message to each connected client
abstract void	close() Completely close the server
abstract Server	debug(boolean status) Set the server debug status
abstract void	exportBans(Path destination) Export the list of bans
abstract Set<RemoteClient>	getClients() Get the connected clients
abstract String	getMAC() Get the server MAC address
abstract WorkLevel	getWorkLevel() Get the server work level
abstract void	kick(String... macAddresses) Kick an address from the server
abstract void	loadBans(Path bans) Load the list of bans
abstract void	redirect(String name, MessageOutput data) Redirect a message to the specified client
abstract ml.karmaconfigs.api.common.timer.scheduler.LateScheduler<Boolean>	start() Try to start the server
abstract ml.karmaconfigs.api.common.timer.scheduler.LateScheduler<Boolean>	start(String accessKey) Try to start the server
abstract void	unBan(String... macAddresses) Unban an address from the server

Methods inherited from class java.lang.Object

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

Methods inherited from interface ml.karmaconfigs.api.common.karma.KarmaSource

async, authors, authors, console, description, getDataPath, getSourceFile, isSource, logger, name, srcEquals, stopTasks, sync, updateURL, version

Constructor Detail

Server

public Server()

Method Detail

debug

public abstract Server debug(boolean status)

Set the server debug status

Parameters:

status - the server debug status

Returns:

this instance

start

public abstract ml.karmaconfigs.api.common.timer.scheduler.LateScheduler<Boolean> start()

Try to start the server

Returns:

a completable future when the server starts

start

public abstract ml.karmaconfigs.api.common.timer.scheduler.LateScheduler<Boolean> start(String accessKey)

Try to start the server

Parameters:

accessKey - the server access key

Returns:

a completable future when the server starts

getMAC

public abstract String getMAC()

Get the server MAC address

Returns:

the server MAC address

getClients

public abstract Set<RemoteClient> getClients()

Get the connected clients

Returns:

a list of connected clients

getWorkLevel

public abstract WorkLevel getWorkLevel()

Get the server work level

Returns:

the server work level

close

public abstract void close()

Completely close the server

exportBans

public abstract void exportBans(Path destination)

Export the list of bans

Parameters:

destination - the file were to store the ban list

loadBans

public abstract void loadBans(Path bans)

Load the list of bans

Parameters:

bans - the file were the banned mac addresses are stored

broadcast

public abstract void broadcast(MessageOutput data)

Send a message to each connected client

Parameters:

data - the data to send

redirect

public abstract void redirect(String name,
                              MessageOutput data)

Redirect a message to the specified client

Parameters:

name - the client name

data - the message

ban

public abstract void ban(String... macAddresses)

Ban an address from the server

Parameters:

macAddresses - the addresses to ban

kick

public abstract void kick(String... macAddresses)

Kick an address from the server

Parameters:

macAddresses - the addresses to kick

unBan

public abstract void unBan(String... macAddresses)

Unban an address from the server

Parameters:

macAddresses - the addresses to unban