ml.karmaconfigs.remote.messaging.worker.tcp

Class TCPServer

java.lang.Object

ml.karmaconfigs.remote.messaging.platform.Server

ml.karmaconfigs.remote.messaging.worker.tcp.TCPServer

All Implemented Interfaces:

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

public final class TCPServer
extends Server

Remote message client interface

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TCPServer() Initialize a default client that will connect to local server at default port 49305
TCPServer(int port) Initialize a client with a custom port that will connect to the specified server at the specified port
TCPServer(String host, int port) Initialize a client that will connect to the specified server at specified port

Method Summary

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

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, getDataPath, getSourceFile, isSource, logger, srcEquals, stopTasks, sync

Constructor Detail

TCPServer

public TCPServer()

Initialize a default client that will connect to local server at default port 49305

TCPServer

public TCPServer(int port)

Initialize a client with a custom port that will connect to the specified server at the specified port

Parameters:

port - the server port

TCPServer

public TCPServer(String host,
                 int port)

Initialize a client that will connect to the specified server at specified port

Parameters:

host - the server

port - the server port

Method Detail

debug

public Server debug(boolean status)

Set the server debug status

Specified by:

debug in class Server

Parameters:

status - the server debug status

Returns:

this instance

start

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

Try to start the server

Specified by:

start in class Server

Returns:

a completable future when the server starts

start

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

Try to start the server

Specified by:

start in class Server

Parameters:

accessKey - the server access key

Returns:

a completable future when the server starts

getMAC

public String getMAC()

Get the server MAC address

Specified by:

getMAC in class Server

Returns:

the server MAC address

getClients

public Set<RemoteClient> getClients()

Get the connected clients

Specified by:

getClients in class Server

Returns:

a list of connected clients

getWorkLevel

public WorkLevel getWorkLevel()

Get the client work level

Specified by:

getWorkLevel in class Server

Returns:

the client work level

close

public void close()

Close the connection

Specified by:

close in class Server

exportBans

public void exportBans(Path destination)

Export the list of bans

Specified by:

exportBans in class Server

Parameters:

destination - the file were to store the ban list

loadBans

public void loadBans(Path bans)

Load the list of bans

Specified by:

loadBans in class Server

Parameters:

bans - the file were the banned mac addresses are stored

broadcast

public void broadcast(MessageOutput data)

Send a message to each connected client

Specified by:

broadcast in class Server

Parameters:

data - the data to send

redirect

public void redirect(String name,
                     MessageOutput data)

Redirect a message to the specified client

Specified by:

redirect in class Server

Parameters:

name - the client name

data - the message

ban

public void ban(String... macAddresses)

Ban an address from the server

Specified by:

ban in class Server

Parameters:

macAddresses - the addresses to ban

kick

public void kick(String... macAddresses)

Kick an address from the server

Specified by:

kick in class Server

Parameters:

macAddresses - the addresses to kick

unBan

public void unBan(String... macAddresses)

Unban an address from the server

Specified by:

unBan in class Server

Parameters:

macAddresses - the addresses to unban

name

public String name()

Karma source name

Returns:

the source name

version

public String version()

Karma source version

Returns:

the source version

description

public String description()

Karma source description

Returns:

the source description

authors

public String[] authors()

Karma source authors

Returns:

the source authors

updateURL

public String updateURL()

Karma source update URL

Returns:

the source update URL

console

public ml.karmaconfigs.api.common.Console console()

Get the source out

Returns:

the source out