Package org.threadly.litesockets.client.http

Class HTTPStreamClient

java.lang.Object

org.threadly.litesockets.client.http.HTTPStreamClient

All Implemented Interfaces:

StreamingClient

public class HTTPStreamClient
extends java.lang.Object
implements StreamingClient

HTTPStreamClient is designed to work with larger HTTPStreams of data. This can mean sending them or receiving them. The basic concept is that once the connection is established and the HTTP headers are send and/or received everything pretty much works like a normal socket connection in litesockets.

The HttpStreamClient can also do many requests/responses in a row w/o closing the connection

Its important to note that if chunked encoding is set in a header anything sent and/or received will automatically remove the chunk headers. If the HTTPResponse is chunked you will get a call to onRead for each chunk but the chunk header will be removed. If you are sending and have turned on chunked encoding every call to .write will add a chunked header to it, and calling .write with a ByteBuffer of 0 will end the stream

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HTTPStreamClient.HTTPStreamReader	Simple HTTPStreamReader callback interface.

Constructor Summary

Constructors

Constructor	Description
HTTPStreamClient(org.threadly.litesockets.SocketExecuter se, java.lang.String host, int port)	When constructing the HTTPStreamClient we connect to a specific server.
HTTPStreamClient(org.threadly.litesockets.TCPClient client)	Creates an HTTPStreaming client from an already existing TCPClient.
HTTPStreamClient(org.threadly.litesockets.TCPClient client, java.lang.String host)	Creates an HTTPStreaming client from an already existing TCPClient.

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.
java.lang.String	getHost()
org.threadly.concurrent.future.ListenableFuture<?>	getLastWriteFuture()
int	getPort()
boolean	isConnected()
void	setConnectionTimeout(int timeout)	This sets the timeout on the connection to the remote host.
void	setHTTPStreamReader(HTTPStreamClient.HTTPStreamReader hsr)	Sets the HTTPStreamReader for this client.
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.
org.threadly.concurrent.future.ListenableFuture<org.threadly.litesockets.protocols.http.response.HTTPResponse>	writeRequest(org.threadly.litesockets.protocols.http.request.HTTPRequest request)	Tell the client to write an HTTPRequest to the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

HTTPStreamClient

public HTTPStreamClient(org.threadly.litesockets.TCPClient client)

Creates an HTTPStreaming client from an already existing TCPClient.

Parameters:

client - the TCPClient to use for this connection.

HTTPStreamClient

public HTTPStreamClient(org.threadly.litesockets.TCPClient client,
                        java.lang.String host)

Creates an HTTPStreaming client from an already existing TCPClient.

Parameters:

client - the TCPClient to use for this connection.

host - the hostname or ip address to connect to.

HTTPStreamClient

public HTTPStreamClient(org.threadly.litesockets.SocketExecuter se,
                        java.lang.String host,
                        int port)
                 throws java.io.IOException

When constructing the HTTPStreamClient we connect to a specific server. If you want to use the HTTPRequest to set the server/port you can use the .getHost() and .getPort() methods on it.

Parameters:

se - the SocketExecuter to use for this client.

host - the hostname or ip address to connect to.

port - the tcp port to connect to.

Throws:

java.io.IOException - this will happen if we have problems connecting for some reason.

Method Detail

enableSSL

public void enableSSL()

Description copied from interface: StreamingClient

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.

Specified by:

enableSSL in interface StreamingClient

enableSSL

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

Description copied from interface: StreamingClient

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.

Specified by:

enableSSL in interface StreamingClient

Parameters:

ssle - the SSLEngine to use for this connection.

setConnectionTimeout

public void setConnectionTimeout(int timeout)

Description copied from interface: StreamingClient

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

Specified by:

setConnectionTimeout in interface StreamingClient

Parameters:

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

getHost

public java.lang.String getHost()

Returns:

the connected Host name/ip.

getPort

public int getPort()

Returns:

Returns the connected port number.

setRequestResponseHeaders

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

Description copied from interface: StreamingClient

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.

Specified by:

setRequestResponseHeaders in interface StreamingClient

writeRequest

public org.threadly.concurrent.future.ListenableFuture<org.threadly.litesockets.protocols.http.response.HTTPResponse> writeRequest(org.threadly.litesockets.protocols.http.request.HTTPRequest request)

Tell the client to write an HTTPRequest to the server. This can technically be done whenever you want to but obviously use only when you know you can sent a request, right after opening a connection for example.

Parameters:

request - the request to send. This is generally done with HTTPRequestBuilders buildHeadersOnly() method. You can send a full request if you expect the response (not the sending) to be a stream.

Returns:

returns a ListenableFuture with the HTTPResponse in it. This might not callback right away, especially if you used buildHeadersOnly() as you still need to stream in your data till its complete. Once complete this should be called.

write

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

Description copied from interface: StreamingClient

This performs a write to the connection.

Specified by:

write in interface StreamingClient

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

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

Specified by:

getLastWriteFuture in interface StreamingClient

setHTTPStreamReader

public void setHTTPStreamReader(HTTPStreamClient.HTTPStreamReader hsr)

Sets the HTTPStreamReader for this client.

Parameters:

hsr - the HTTPStreamClient.HTTPStreamReader

getClientsThreadExecutor

public java.util.concurrent.Executor getClientsThreadExecutor()

Description copied from interface: StreamingClient

Gets the Executor for this client.

Specified by:

getClientsThreadExecutor in interface StreamingClient

Returns:

the Executor for this client.

connect

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

Description copied from interface: StreamingClient

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.

Specified by:

connect in interface StreamingClient

Returns:

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

addCloseListener

public void addCloseListener(java.lang.Runnable cl)

Description copied from interface: StreamingClient

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

Specified by:

addCloseListener in interface StreamingClient

Parameters:

cl - the runnable to run on the connection close.

isConnected

public boolean isConnected()

Specified by:

isConnected in interface StreamingClient

Returns:

true if the client is connected and false if not.

close

public void close()

Description copied from interface: StreamingClient

This will close the client.

Specified by:

close in interface StreamingClient