Package org.threadly.litesockets.client.http

Interface StreamingClient

All Known Implementing Classes:

HTTPStreamClient, WSClient

public interface StreamingClient

Basic interface for StreamingClients.

Method Summary

Modifier and Type	Method	Description
void	addCloseListener(java.lang.Runnable cl)	Sets a runnable to be ran once this connection is closed.
void	close()	This will close the client.
org.threadly.concurrent.future.ListenableFuture<java.lang.Boolean>	connect()	This is called to connect this client to the server.
void	enableSSL()	This is called to enable ssl on this connection.
void	enableSSL(javax.net.ssl.SSLEngine ssle)	This is called to enable ssl on this connection.
java.util.concurrent.Executor	getClientsThreadExecutor()	Gets the Executor for this client.
org.threadly.concurrent.future.ListenableFuture<?>	getLastWriteFuture()
boolean	isConnected()
void	setConnectionTimeout(int timeout)	This sets the timeout on the connection to the remote host.
void	setRequestResponseHeaders(org.threadly.litesockets.protocols.http.request.HTTPRequest httpRequest, org.threadly.litesockets.protocols.http.response.HTTPResponse httpResponse, boolean writeResponse)	Sets the HTTPRequest and HTTPResponse allowing the streaming client to start streaming w/o sending these in itself.
org.threadly.concurrent.future.ListenableFuture<?>	write(java.nio.ByteBuffer bb)	This performs a write to the connection.

Method Detail

enableSSL

void enableSSL()

This is called to enable ssl on this connection. This can only be done before connect is called. This is the default ssl handler meaning there is no server side certificate validation done.

enableSSL

void enableSSL(javax.net.ssl.SSLEngine ssle)

This is called to enable ssl on this connection. This can only be done before connect is called. This method allows you to set the SSLEngine to use for this connection allow you to validate the certificates if needed.

Parameters:

ssle - the SSLEngine to use for this connection.

setConnectionTimeout

void setConnectionTimeout(int timeout)

This sets the timeout on the connection to the remote host. This can only be set before the connect() is called.

Parameters:

timeout - the timeout in milliseconds to use for this connection.

setRequestResponseHeaders

void setRequestResponseHeaders(org.threadly.litesockets.protocols.http.request.HTTPRequest httpRequest,
                               org.threadly.litesockets.protocols.http.response.HTTPResponse httpResponse,
                               boolean writeResponse)

Sets the HTTPRequest and HTTPResponse allowing the streaming client to start streaming w/o sending these in itself. This is used for the server side of streaming.

Parameters:

httpRequest -

httpResponse -

writeResponse -

write

org.threadly.concurrent.future.ListenableFuture<?> write(java.nio.ByteBuffer bb)

This performs a write to the connection.

Parameters:

bb - the ByteBuffer to write to socket.

Returns:

a ListenableFuture that will be completed once the frame has been fully written to the socket.

getLastWriteFuture

org.threadly.concurrent.future.ListenableFuture<?> getLastWriteFuture()

connect

org.threadly.concurrent.future.ListenableFuture<java.lang.Boolean> connect()

This is called to connect this client to the server. This will also send in the HTTP upgrade request once the TCP connection is finished.

Returns:

a ListenableFuture that will be completed when the upgrade is complete, if the upgrade fails the a ListenableFuture be failed.

addCloseListener

void addCloseListener(java.lang.Runnable cl)

Sets a runnable to be ran once this connection is closed.

Parameters:

cl - the runnable to run on the connection close.

isConnected

boolean isConnected()

Returns:

true if the client is connected and false if not.

close

void close()

This will close the client.

getClientsThreadExecutor

java.util.concurrent.Executor getClientsThreadExecutor()

Gets the Executor for this client.

Returns:

the Executor for this client.