Package com.launchdarkly.eventsource

Class ConnectStrategy.Client

java.lang.Object

com.launchdarkly.eventsource.ConnectStrategy.Client

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

ConnectStrategy

public abstract static class ConnectStrategy.Client
extends Object
implements Closeable

An object provided by ConnectStrategy that is retained by a single EventSource instance to perform all connection attempts by that instance.

For the default HTTP implementation, this represents a configured HTTP client.

The Closeable.close() method should be implemented to do any necessary cleanup when an EventSource instance is being permanently disposed of.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConnectStrategy.Client.Result	The return type of connect(String).

Constructor Summary

Constructors

Constructor	Description
Client()

Method Summary

Modifier and Type	Method	Description
abstract boolean	awaitClosed(long timeoutMillis)	Implements EventSource.awaitClosed(long, java.util.concurrent.TimeUnit).
abstract ConnectStrategy.Client.Result	connect(String lastEventId)	Attempts to connect to a stream.
abstract URI	getOrigin()	Returns the expected URI of the stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Constructor Details

Client

public Client()

Method Details

connect

public abstract ConnectStrategy.Client.Result connect(String lastEventId)
                                               throws StreamException

Attempts to connect to a stream.

Parameters:

lastEventId - the current value of EventSource.getLastEventId() (should be sent to the server to support resuming an interrupted stream)

Returns:

the result if successful

Throws:

StreamException - if not successful

awaitClosed

public abstract boolean awaitClosed(long timeoutMillis)
                             throws InterruptedException

Implements EventSource.awaitClosed(long, java.util.concurrent.TimeUnit).

Parameters:

timeoutMillis - maximum amount of time to wait

Returns:

true if all requests are now closed

Throws:

InterruptedException - if the thread is interrupted

getOrigin

public abstract URI getOrigin()

Returns the expected URI of the stream.

This value is returned by EventSource.getOrigin(). It can be overridden on a per-connection basis with ConnectStrategy.Client.Result.getOrigin().

Returns:

the stream URI