io.aeron.cluster.client

Class AeronCluster.AsyncConnect

java.lang.Object

io.aeron.cluster.client.AeronCluster.AsyncConnect

All Implemented Interfaces:

AutoCloseable

Enclosing class:

AeronCluster

public static final class AeronCluster.AsyncConnect
extends Object
implements AutoCloseable

Allows for the async establishment of a cluster session. poll() should be called repeatedly until it returns a non-null value with the new AeronCluster client. On error close() should be called to clean up allocated resources.

Method Summary

Modifier and Type	Method and Description
void	close() Close allocated resources.
AeronCluster	poll() Poll to advance steps in the connection until complete or error.
int	step() Indicates which step in the connect process has been reached.
static String	stepName(int step) Get the String representation of a step in the connect process.

Methods inherited from class java.lang.Object

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

Method Detail

close

public void close()

Close allocated resources. Must be called on error. On success this is a no op.

Specified by:

close in interface AutoCloseable

step

public int step()

Indicates which step in the connect process has been reached.

Returns:

which step in the connect process has reached.

stepName

public static String stepName(int step)

Get the String representation of a step in the connect process.

Parameters:

step - to get the string representation for.

Returns:

the String representation of a step in the connect process.

See Also:

step()

poll

public AeronCluster poll()

Poll to advance steps in the connection until complete or error.

Returns:

null if not yet complete then AeronCluster when complete.