net.scattersphere.api

Class ClientConnection

java.lang.Object

net.scattersphere.api.ClientConnection

public class ClientConnection
extends Object

This class handles the connection for the CLI to the endpoint server. All connection operations are handled asynchronously, which means that a handler must be established to support whatever command is expected. Created by kenji on 11/29/14.

Constructor Summary

Constructors

Constructor and Description
ClientConnection() Constructor.
ClientConnection(boolean streamMode) Constructor, used to specify streaming mode if set.

Method Summary

Modifier and Type	Method and Description
ClientConnection	authReceived(Consumer<ServerAuthResponseMessage> onAuthentication) Lambda function called when an authentication message is received.
void	connect(String endpointSent) Connects to a specified address, in the format of "address" or "address:port".
void	disconnect() Handles the disconnection from the currently active client.
String	getConnectStatus() Returns the status of the current connection.
boolean	isConnected() Flag indicating whether or not the connection is active.
ClientConnection	messageReceived(Consumer<JobMessage> onMessage) Lambda function called when a message is received from the endpoint.
ClientConnection	onConnect(Consumer<ClientConnectionState> onConnect) Lambda function called when a connection has been established.
void	sendMessage(byte[] data) Sends a command payload to the server, packetizing the data (header with length), and sending it across the wire in a Buffer.
ClientConnection	streamReceived(Consumer<byte[]> onStream) Lambda function called when a stream of byte data is received.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientConnection

public ClientConnection()

Constructor.

ClientConnection

public ClientConnection(boolean streamMode)

Constructor, used to specify streaming mode if set.

Parameters:

streamMode - true if streaming mode (port 10002), false otherwise for port 10001.

Method Detail

onConnect

public ClientConnection onConnect(Consumer<ClientConnectionState> onConnect)

Lambda function called when a connection has been established.

Parameters:

onConnect - Consumer function that takes a ClientConnectionState indicating the connection state.

Returns:

This current class.

messageReceived

public ClientConnection messageReceived(Consumer<JobMessage> onMessage)

Lambda function called when a message is received from the endpoint.

Parameters:

onMessage - Consumer function that takes a JobMessage object.

Returns:

This current class.

streamReceived

public ClientConnection streamReceived(Consumer<byte[]> onStream)

Lambda function called when a stream of byte data is received.

Parameters:

onStream - Consumer function that takes a byte[] array of data.

Returns:

This current class.

authReceived

public ClientConnection authReceived(Consumer<ServerAuthResponseMessage> onAuthentication)

Lambda function called when an authentication message is received.

Parameters:

onAuthentication - Consumer function that takes a ServerAuthResponseMessage object.

Returns:

This current class.

connect

public void connect(String endpointSent)

Connects to a specified address, in the format of "address" or "address:port". If no port is specified, port 10001 is used by default.

Parameters:

endpointSent - The endpoint address to connect to.

disconnect

public void disconnect()

Handles the disconnection from the currently active client.

sendMessage

public void sendMessage(byte[] data)

Sends a command payload to the server, packetizing the data (header with length), and sending it across the wire in a Buffer.

Parameters:

data - A byte[] array of data to send.

getConnectStatus

public String getConnectStatus()

Returns the status of the current connection.

Returns:

String containing a human-readable representation of the connection status.

isConnected

public boolean isConnected()

Flag indicating whether or not the connection is active.

Returns:

true if the connection is active, false otherwise.