A C D G I L M N O S V

A

addClient(String, String) - Method in class net.scattersphere.api.Client

Adds a connection to a server, assigning a name to that connection.

addClient(String, String) - Method in class net.scattersphere.api.StreamClient

Adds a connection to a server, assigning a name to that connection.

authenticate(String, String, String) - Method in class net.scattersphere.api.Client

Attempts to login to the specified server.

authReceived(Consumer<ServerAuthResponseMessage>) - Method in class net.scattersphere.api.ClientConnection

Lambda function called when an authentication message is received.

C

Client - Class in net.scattersphere.api

This portion of the API handles commands sent to a client endpoint.

Client() - Constructor for class net.scattersphere.api.Client

Constructor.

ClientConnection - Class in net.scattersphere.api

This class handles the connection for the CLI to the endpoint server.

ClientConnection() - Constructor for class net.scattersphere.api.ClientConnection

Constructor.

ClientConnection(boolean) - Constructor for class net.scattersphere.api.ClientConnection

Constructor, used to specify streaming mode if set.

ClientConnectionState - Enum in net.scattersphere.api

These are the client connection states that occur during a connection.

closeStream(String, String) - Method in class net.scattersphere.api.StreamClient

Unsubscribes from a stream by ID.

connect(String) - Method in class net.scattersphere.api.ClientConnection

Connects to a specified address, in the format of "address" or "address:port".

D

disconnect() - Method in class net.scattersphere.api.ClientConnection

Handles the disconnection from the currently active client.

G

getClientConnection(String) - Method in class net.scattersphere.api.Client

Retrieves the underlying ClientConnection, which is the communication layer to the endpoint.

getClientConnection(String) - Method in class net.scattersphere.api.StreamClient

Retrieves the underlying ClientConnection, which is the communication layer to the endpoint.

getConnectStatus() - Method in class net.scattersphere.api.ClientConnection

Returns the status of the current connection.

I

isConnected() - Method in class net.scattersphere.api.ClientConnection

Flag indicating whether or not the connection is active.

L

listJobs(String) - Method in class net.scattersphere.api.Client

Requests a list of jobs from the specified server.

listJobs(String, String) - Method in class net.scattersphere.api.Client

Requests a list of jobs of a specific type from the specified server.

M

messageReceived(Consumer<JobMessage>) - Method in class net.scattersphere.api.ClientConnection

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

N

net.scattersphere.api - package net.scattersphere.api

O

onAuthentication(Consumer<Boolean>) - Method in class net.scattersphere.api.Client

Lambda function called when authentication is accepted or denied.

onConnect(Consumer<String>) - Method in class net.scattersphere.api.Client

Lambda function called when a connection is successful.

onConnect(Consumer<ClientConnectionState>) - Method in class net.scattersphere.api.ClientConnection

Lambda function called when a connection has been established.

onConnect(Consumer<String>) - Method in class net.scattersphere.api.StreamClient

Lambda function called when a connection is successful.

onDisconnect(Consumer<String>) - Method in class net.scattersphere.api.Client

Lambda function called when a connection is lost, or dropped.

onDisconnect(Consumer<String>) - Method in class net.scattersphere.api.StreamClient

Lambda function called when a connection is lost, or dropped.

onMessage(BiConsumer<String, JobMessage>) - Method in class net.scattersphere.api.Client

Lambda function called when a message is received from a server.

onStream(BiConsumer<String, byte[]>) - Method in class net.scattersphere.api.StreamClient

Lambda function called when a stream packet is receive from a server.

openStream(String, String) - Method in class net.scattersphere.api.StreamClient

Subscribes to a stream by ID.

S

send(String, JobMessage) - Method in class net.scattersphere.api.Client

Sends a message to the specified server.

sendMessage(byte[]) - Method in class net.scattersphere.api.ClientConnection

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

startJob(String, String, String[]) - Method in class net.scattersphere.api.Client

Starts a job by name, with specified arguments.

statusJob(String, String) - Method in class net.scattersphere.api.Client

Retrieves status for a job by ID.

stopJob(String, String, String) - Method in class net.scattersphere.api.Client

Stops a job by its ID.

StreamClient - Class in net.scattersphere.api

This API handles the action of subscribing to a stream by job ID to servers.

StreamClient() - Constructor for class net.scattersphere.api.StreamClient

streamJob(String, String, String) - Method in class net.scattersphere.api.Client

Controls a stream from a connection.

streamReceived(Consumer<byte[]>) - Method in class net.scattersphere.api.ClientConnection

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

V

valueOf(String) - Static method in enum net.scattersphere.api.ClientConnectionState

Returns the enum constant of this type with the specified name.

values() - Static method in enum net.scattersphere.api.ClientConnectionState

Returns an array containing the constants of this enum type, in the order they are declared.

A C D G I L M N O S V