ml.karmaconfigs.remote.messaging.worker.tcp

Class TCPClient

java.lang.Object

ml.karmaconfigs.remote.messaging.Client

ml.karmaconfigs.remote.messaging.worker.tcp.TCPClient

All Implemented Interfaces:

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

public final class TCPClient
extends Client

Remote message client interface

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TCPClient() Initialize a default client that will connect to local server at default port 49305
TCPClient(int client_port, String server_host, int server_port) Initialize a client with a custom port that will connect to the specified server at the specified port
TCPClient(String server_host, int server_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	close() Close the connection
ml.karmaconfigs.api.common.timer.scheduler.LateScheduler<Boolean>	connect() Try to connect to the server
ml.karmaconfigs.api.common.timer.scheduler.LateScheduler<Boolean>	connect(String accessKey) Try to connect to the server
Client	debug(boolean status) Set the client debug status
String	description() Karma source description
String	getMAC() Get the client MAC address
String	getName() Get the client name
RemoteServer	getServer() Get the connected remote server
WorkLevel	getWorkLevel() Get the client work level
String	name() Karma source name
void	rename(String name) Rename the client on the server interface
void	send(byte[] data) Send data to 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, console, getDataPath, getSourceFile, isSource, logger, srcEquals, stopTasks, sync

Constructor Detail

TCPClient

public TCPClient()

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

TCPClient

public TCPClient(String server_host,
                 int server_port)

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

Parameters:

server_host - the server

server_port - the server port

TCPClient

public TCPClient(int client_port,
                 String server_host,
                 int server_port)

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

Parameters:

client_port - the client port

server_host - the server

server_port - the server port

Method Detail

debug

public Client debug(boolean status)

Set the client debug status

Specified by:

debug in class Client

Parameters:

status - the client debug status

Returns:

this instance

connect

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

Try to connect to the server

Specified by:

connect in class Client

Returns:

a completable future when the client connects

connect

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

Try to connect to the server

Specified by:

connect in class Client

Parameters:

accessKey - the server access key

Returns:

a completable future when the client connects

getName

public String getName()

Get the client name

Specified by:

getName in class Client

Returns:

the client name

getMAC

public String getMAC()

Get the client MAC address

Specified by:

getMAC in class Client

Returns:

the client MAC address

getServer

public RemoteServer getServer()

Get the connected remote server

Specified by:

getServer in class Client

Returns:

the connected remote server

getWorkLevel

public WorkLevel getWorkLevel()

Get the client work level

Specified by:

getWorkLevel in class Client

Returns:

the client work level

rename

public void rename(String name)

Rename the client on the server interface

Specified by:

rename in class Client

Parameters:

name - the client name

send

public void send(byte[] data)

Send data to the server

Specified by:

send in class Client

Parameters:

data - the data to send

close

public void close()

Close the connection

Specified by:

close in class Client

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