net.kuujo.catalyst.transport

Interface Transport

public interface Transport

Transport provider.

This is a low level abstraction that serves to provide Catalyst clients and servers with Client and Server instances. Throughout the lifetime of a Transport, Catalyst may call on the transport to create multiple Client and Server objects. Each Client and Server is identified by a UUID which is assumed to be unique to that instance across the entire Catalyst cluster.

When the Transport is closed, it should close all Client and Server instances created by it if they're not already closed.

Author:

Jordan Halterman

Method Summary

Modifier and Type	Method and Description
Client	client(UUID id) Creates a transport client.
CompletableFuture<Void>	close() Closes the transport.
Server	server(UUID id) Creates a transport server.

Method Detail

client

Client client(UUID id)

Creates a transport client.

The provided UUID is a cluster-wide unique identifier for the client. The Connection.id() for all Connection objects created by the client should reflect the provided id. Additionally, Connection objects created by any Server to which the provided client connects should have the same Connection.id() .

Parameters:

id - The client ID.

Returns:

The transport client.

Throws:

NullPointerException - if id is null

server

Server server(UUID id)

Creates a transport server.

The provided UUID is a cluster-wide unique identifier for the client. However, note that Connection objects created by the provided Server should be created with the Connection.id() of the connecting Client and not the provided Server itself.

Parameters:

id - The server ID.

Returns:

The transport server.

Throws:

NullPointerException - if id is null

close

CompletableFuture<Void> close()

Closes the transport.

When the transport is closed, all Client and Server objects provided by the Transport should be closed if not closed already.

Returns:

A completable future to be completed once the transport is closed.