org.corfudb.runtime.clients

Interface IClientRouter

All Known Implementing Classes:

NettyClientRouter

public interface IClientRouter

This is an interface in which all client routers must implement. Client routers are classes which talk to server routers. Clients are registered on client routers using the addClient() interface, and can be retrieved using the getClient() interface.

Created by mwei on 12/13/15.

Method Summary

Modifier and Type	Method and Description
IClientRouter	addClient(IClient client) Add a new client to the router.
void	completeExceptionally(long requestID, Throwable cause) Exceptionally complete a request with a given cause.
<T> void	completeRequest(long requestID, T completion) Complete a given outstanding request with a completion value.
<T extends IClient> T	getClient(Class<T> clientType) Gets a client that matches a particular type.
String	getHost() The host that this router is routing requests for.
Integer	getPort() The port that this router is routing requests for.
void	sendMessage(io.netty.channel.ChannelHandlerContext ctx, CorfuMsg message) Send a one way message, without adding a completable future.
default void	sendMessage(CorfuMsg message) Send a one way message using the default channel handler, without adding a completable future.
<T> CompletableFuture<T>	sendMessageAndGetCompletable(io.netty.channel.ChannelHandlerContext ctx, CorfuMsg message) Send a message and get a completable future to be fulfilled by the reply.
default <T> CompletableFuture<T>	sendMessageAndGetCompletable(CorfuMsg message) Send a message using the router channel handler and get a completable future to be fulfilled by the reply.
void	sendResponseToServer(io.netty.channel.ChannelHandlerContext ctx, CorfuMsg inMsg, CorfuMsg outMsg) Send a netty message through this router, setting the fields in the outgoing message.
void	setTimeoutConnect(long timeoutConnect) Set the Connect timeout
void	setTimeoutResponse(long timeoutResponse) Set the Response timeout
void	setTimeoutRetry(long timeoutRetry) Set the retry timeout
void	start() Starts routing requests.
void	stop() Stops routing requests.
void	stop(boolean shutdown)

Method Detail

addClient

IClientRouter addClient(IClient client)

Add a new client to the router.

Parameters:

client - The client to add to the router.

Returns:

This IClientRouter, to support chaining and the builder pattern.

getClient

<T extends IClient> T getClient(Class<T> clientType)

Gets a client that matches a particular type.

Type Parameters:

T - The type of the client to match.

Parameters:

clientType - The class of the client to match.

Returns:

The first client that matches that type.

Throws:

NoSuchElementException - If there are no clients matching that type.

sendMessageAndGetCompletable

<T> CompletableFuture<T> sendMessageAndGetCompletable(io.netty.channel.ChannelHandlerContext ctx,
                                                      CorfuMsg message)

Send a message and get a completable future to be fulfilled by the reply.

Type Parameters:

T - The type of completable to return.

Parameters:

ctx - The channel handler context to send the message under.

message - The message to send.

Returns:

A completable future which will be fulfilled by the reply, or a timeout in the case there is no response.

sendMessageAndGetCompletable

default <T> CompletableFuture<T> sendMessageAndGetCompletable(CorfuMsg message)

Send a message using the router channel handler and get a completable future to be fulfilled by the reply.

Type Parameters:

T - The type of completable to return.

Parameters:

message - The message to send.

Returns:

A completable future which will be fulfilled by the reply, or a timeout in the case there is no response.

sendMessage

void sendMessage(io.netty.channel.ChannelHandlerContext ctx,
                 CorfuMsg message)

Send a one way message, without adding a completable future.

Parameters:

ctx - The context to send the message under.

message - The message to send.

sendMessage

default void sendMessage(CorfuMsg message)

Send a one way message using the default channel handler, without adding a completable future.

Parameters:

message - The message to send.

sendResponseToServer

void sendResponseToServer(io.netty.channel.ChannelHandlerContext ctx,
                          CorfuMsg inMsg,
                          CorfuMsg outMsg)

Send a netty message through this router, setting the fields in the outgoing message.

Parameters:

ctx - Channel handler context to use.

inMsg - Incoming message to respond to.

outMsg - Outgoing message.

completeRequest

<T> void completeRequest(long requestID,
                         T completion)

Complete a given outstanding request with a completion value.

Type Parameters:

T - The type of the completion.

Parameters:

requestID - The request to complete.

completion - The value to complete the request with

completeExceptionally

void completeExceptionally(long requestID,
                           Throwable cause)

Exceptionally complete a request with a given cause.

Parameters:

requestID - The request to complete.

cause - The cause to give for the exceptional completion.

start

void start()

Starts routing requests.

stop

void stop()

Stops routing requests.

stop

void stop(boolean shutdown)

getHost

String getHost()

The host that this router is routing requests for.

getPort

Integer getPort()

The port that this router is routing requests for.

setTimeoutConnect

void setTimeoutConnect(long timeoutConnect)

Set the Connect timeout

Parameters:

timeoutConnect - timeout for connection in milliseconds.

setTimeoutRetry

void setTimeoutRetry(long timeoutRetry)

Set the retry timeout

Parameters:

timeoutRetry - timeout to make a retry in milliseconds.

setTimeoutResponse

void setTimeoutResponse(long timeoutResponse)

Set the Response timeout

Parameters:

timeoutResponse - Response timeout in milliseconds.