net.scattersphere.api

Class StreamClient

java.lang.Object

net.scattersphere.api.StreamClient

public class StreamClient
extends Object

This API handles the action of subscribing to a stream by job ID to servers. It handles the retrieval of data from a job in real time, in packets at a time.

Packets are only sent to the onStream function as they are received in full. This API will buffer all data from a connection. Created by kenji on 2/8/15.

Constructor Summary

Constructors

Constructor and Description
StreamClient()

Method Summary

Modifier and Type	Method and Description
void	addClient(String clientName, String clientAddress) Adds a connection to a server, assigning a name to that connection.
void	closeStream(String clientName, String streamId) Unsubscribes from a stream by ID.
ClientConnection	getClientConnection(String clientName) Retrieves the underlying ClientConnection, which is the communication layer to the endpoint.
StreamClient	onConnect(Consumer<String> function) Lambda function called when a connection is successful.
StreamClient	onDisconnect(Consumer<String> function) Lambda function called when a connection is lost, or dropped.
StreamClient	onStream(BiConsumer<String,byte[]> function) Lambda function called when a stream packet is receive from a server.
void	openStream(String clientName, String streamId) Subscribes to a stream by ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamClient

public StreamClient()

Method Detail

addClient

public void addClient(String clientName,
                      String clientAddress)

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

Parameters:

clientName - The name of the connection to assign.

clientAddress - The address to connect to.

getClientConnection

public ClientConnection getClientConnection(String clientName)

Retrieves the underlying ClientConnection, which is the communication layer to the endpoint. This is available for use if required.

Parameters:

clientName - The name of the connection to retrieve.

Returns:

ClientConnection if found.

openStream

public void openStream(String clientName,
                       String streamId)

Subscribes to a stream by ID.

Parameters:

clientName - The client connection to connect to.

streamId - String containing the stream ID.

closeStream

public void closeStream(String clientName,
                        String streamId)

Unsubscribes from a stream by ID.

Parameters:

clientName - The client connection to connect to.

streamId - String containing the stream ID.

onConnect

public StreamClient onConnect(Consumer<String> function)

Lambda function called when a connection is successful.

Parameters:

function - The Consumer function to set.

Returns:

StreamClient object for command chaining.

onDisconnect

public StreamClient onDisconnect(Consumer<String> function)

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

Parameters:

function - The Consumer function to set.

Returns:

StreamClient object for command chaining.

onStream

public StreamClient onStream(BiConsumer<String,byte[]> function)

Lambda function called when a stream packet is receive from a server. If a stream has closed, this function will no longer be called.

Parameters:

function - The BiConsumer of streamId, byte[] data received from the server for the specified stream.

Returns:

StreamClient object for command chaining.