net.kuujo.catalyst.transport

Interface Client

public interface Client

Transport client.

This is a low-level abstraction through which Catalyst clients connect to servers. Users should never use this API directly.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Void>	close() Closes the client.
CompletableFuture<Connection>	connect(Address address) Connects the client to the given address.
UUID	id() Returns the client ID.

Method Detail

id

UUID id()

Returns the client ID.

The client ID is a globally unique UUID that identifies connections between this Client and a remote Server.

When a client connects to a server, the client will establish the connection by sending the server its ID. This allows the server to identify connected clients via Connection.id().

Returns:

The client ID.

connect

CompletableFuture<Connection> connect(Address address)

Connects the client to the given address.

Once the client connects to the given address, the Connection will be established by sharing the client's id() with the server and the returned future will be completed. The resulting Connection.id() will equal the client id().

Parameters:

address - The address to which to connect.

Returns:

A completable future to be completed once the client has been connected.

Throws:

NullPointerException - if address is null

IllegalStateException - if not called from a Catalyst thread

close

CompletableFuture<Void> close()

Closes the client.

Before the client is closed, all Connections opened by the client will be closed and any registered Connection.closeListener(java.util.function.Consumer)s will be invoked.

Returns:

A completable future to be called once the client is closed.

Throws:

IllegalStateException - if not called from a Catalyst thread