ml.karmaconfigs.remote.messaging.platform

Class Client

java.lang.Object

ml.karmaconfigs.remote.messaging.remote.RemoteClient

ml.karmaconfigs.remote.messaging.platform.Client

All Implemented Interfaces:

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

Direct Known Subclasses:

SecureClient, TCPClient

public abstract class Client
extends RemoteClient
implements ml.karmaconfigs.api.common.karma.KarmaSource

Remote message client interface

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Client()

Method Summary

Modifier and Type	Method and Description
abstract void	close() Close the connection
abstract ml.karmaconfigs.api.common.timer.scheduler.LateScheduler<Boolean>	connect() Try to connect to the server
abstract ml.karmaconfigs.api.common.timer.scheduler.LateScheduler<Boolean>	connect(String accessKey) Try to connect to the server
abstract Client	debug(boolean status) Set the client debug status
abstract String	getMAC() Get the client MAC address
abstract String	getName() Get the client name
abstract RemoteServer	getServer() Get the connected remote server
abstract WorkLevel	getWorkLevel() Get the client work level
abstract boolean	isConnected() Get if the client is completely connected to the server
abstract boolean	isConnecting() Get if the client is trying to connect to the server
abstract void	rename(String name) Rename the client on the server interface
abstract void	send(byte[] data) Send data to the server

Methods inherited from class ml.karmaconfigs.remote.messaging.remote.RemoteClient

getHost, getPort, sendMessage, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

Client

public Client()

Method Detail

debug

public abstract Client debug(boolean status)

Set the client debug status

Parameters:

status - the client debug status

Returns:

this instance

connect

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

Try to connect to the server

Returns:

a completable future when the client connects

connect

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

Try to connect to the server

Parameters:

accessKey - the server access key

Returns:

a completable future when the client connects

getName

public abstract String getName()

Get the client name

Specified by:

getName in class RemoteClient

Returns:

the client name

getMAC

public abstract String getMAC()

Get the client MAC address

Specified by:

getMAC in class RemoteClient

Returns:

the client MAC address

getServer

public abstract RemoteServer getServer()

Get the connected remote server

Returns:

the connected remote server

getWorkLevel

public abstract WorkLevel getWorkLevel()

Get the client work level

Returns:

the client work level

isConnecting

public abstract boolean isConnecting()

Get if the client is trying to connect to the server

Returns:

if the client is trying to connect to the server

isConnected

public abstract boolean isConnected()

Get if the client is completely connected to the server

Returns:

if the client is connected

rename

public abstract void rename(String name)

Rename the client on the server interface

Parameters:

name - the client name

send

public abstract void send(byte[] data)

Send data to the server

Parameters:

data - the data to send

close

public abstract void close()

Close the connection