org.corfudb.runtime.clients

Class NettyClientRouter

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<CorfuMsg>

org.corfudb.runtime.clients.NettyClientRouter

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, IClientRouter

@ChannelHandler.Sharable
public class NettyClientRouter
extends io.netty.channel.SimpleChannelInboundHandler<CorfuMsg>
implements IClientRouter

A client router which multiplexes operations over the Netty transport.

Created by mwei on 12/8/15.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
List<IClient>	clientList The clients registered to this router.
Map<CorfuMsgType,IClient>	handlerMap The handlers registered to this router.
Map<Long,CompletableFuture>	outstandingRequests The outstanding requests on this router.
AtomicLong	requestID Deprecated.
boolean	shutdown Whether or not this router is shutdown.
long	timeoutConnect New connection timeout (milliseconds).
long	timeoutResponse Sync call response timeout (milliseconds).
long	timeoutRetry Retry interval after timeout (milliseconds).

Constructor Summary

Constructors

Constructor and Description
NettyClientRouter(NodeLocator node, CorfuRuntime.CorfuRuntimeParameters parameters)
NettyClientRouter(NodeLocator node, io.netty.channel.EventLoopGroup eventLoopGroup, CorfuRuntime.CorfuRuntimeParameters parameters) Creates a new NettyClientRouter connected to the specified host and port with the specified tls and sasl options.
NettyClientRouter(String endpoint) Deprecated. Use this#NettyClientRouter(NodeLocator, CorfuRuntimeParameters)
NettyClientRouter(String host, Integer port) Deprecated. Use this#NettyClientRouter(NodeLocator, CorfuRuntimeParameters)
NettyClientRouter(String host, Integer port, Boolean tls, String keyStore, String ksPasswordFile, String trustStore, String tsPasswordFile, Boolean saslPlainText, String usernameFile, String passwordFile) Deprecated. Use this#NettyClientRouter(NodeLocator, CorfuRuntimeParameters)

Method Summary

Modifier and Type	Method and Description
IClientRouter	addClient(IClient client) Add a new client to the router.
protected void	channelRead0(io.netty.channel.ChannelHandlerContext ctx, CorfuMsg m)
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.
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
<T extends IClient> T	getClient(Class<T> clientType) Gets a client that matches a particular type.
String	getHost() Deprecated.
Integer	getPort() Deprecated.
void	sendMessage(io.netty.channel.ChannelHandlerContext ctx, CorfuMsg message) Send a one way message, 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.
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	start() Deprecated. The router automatically starts now, so this function call is no longer necessary
void	stop() Stops routing requests.
void	stop(boolean shutdown) Deprecated. Deprecated, stopping a router without shutting it down is no longer supported. Please use this#stop().
void	userEventTriggered(io.netty.channel.ChannelHandlerContext ctx, Object evt)

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.corfudb.runtime.clients.IClientRouter

sendMessage, sendMessageAndGetCompletable, setTimeoutConnect, setTimeoutResponse, setTimeoutRetry

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

timeoutConnect

public long timeoutConnect

New connection timeout (milliseconds).

timeoutResponse

public long timeoutResponse

Sync call response timeout (milliseconds).

timeoutRetry

public long timeoutRetry

Retry interval after timeout (milliseconds).

requestID

@Deprecated
public AtomicLong requestID

Deprecated.

The current request ID.

handlerMap

public Map<CorfuMsgType,IClient> handlerMap

The handlers registered to this router.

clientList

public List<IClient> clientList

The clients registered to this router.

outstandingRequests

public Map<Long,CompletableFuture> outstandingRequests

The outstanding requests on this router.

shutdown

public volatile boolean shutdown

Whether or not this router is shutdown.

Constructor Detail

NettyClientRouter

public NettyClientRouter(@Nonnull
                         NodeLocator node,
                         @Nonnull
                         io.netty.channel.EventLoopGroup eventLoopGroup,
                         @Nonnull
                         CorfuRuntime.CorfuRuntimeParameters parameters)

Creates a new NettyClientRouter connected to the specified host and port with the specified tls and sasl options. The new this will attempt connection to the node until this#stop() is called.

Parameters:

node - The node to connect to.

eventLoopGroup - The EventLoopGroup for servicing I/O.

parameters - A CorfuRuntime.CorfuRuntimeParameters with the desired configuration.

NettyClientRouter

@Deprecated
public NettyClientRouter(String endpoint)

Deprecated. Use this#NettyClientRouter(NodeLocator, CorfuRuntimeParameters)

Creates a new NettyClientRouter connected to the specified endpoint.

Parameters:

endpoint - Endpoint to connectAsync to.

NettyClientRouter

@Deprecated
public NettyClientRouter(String host,
                                     Integer port)

Deprecated. Use this#NettyClientRouter(NodeLocator, CorfuRuntimeParameters)

Creates a new NettyClientRouter connected to the specified host and port.

Parameters:

host - Host to connectAsync to.

port - Port to connectAsync to.

NettyClientRouter

@Deprecated
public NettyClientRouter(String host,
                                     Integer port,
                                     Boolean tls,
                                     String keyStore,
                                     String ksPasswordFile,
                                     String trustStore,
                                     String tsPasswordFile,
                                     Boolean saslPlainText,
                                     String usernameFile,
                                     String passwordFile)

Deprecated. Use this#NettyClientRouter(NodeLocator, CorfuRuntimeParameters)

Creates a new NettyClientRouter connected to the specified host and port.

Parameters:

host - Host to connectAsync to.

port - Port to connectAsync to.

NettyClientRouter

public NettyClientRouter(@Nonnull
                         NodeLocator node,
                         @Nonnull
                         CorfuRuntime.CorfuRuntimeParameters parameters)

Method Detail

addClient

public IClientRouter addClient(IClient client)

Add a new client to the router.

Specified by:

addClient in interface IClientRouter

Parameters:

client - The client to add to the router.

Returns:

This NettyClientRouter, to support chaining and the builder pattern.

getClient

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

Gets a client that matches a particular type.

Specified by:

getClient in interface IClientRouter

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.

start

@Deprecated
public void start()

Deprecated. The router automatically starts now, so this function call is no longer necessary

Starts routing requests..

Specified by:

start in interface IClientRouter

stop

public void stop()

Stops routing requests.

Specified by:

stop in interface IClientRouter

stop

@Deprecated
public void stop(boolean shutdown)

Deprecated. Deprecated, stopping a router without shutting it down is no longer supported. Please use this#stop().

Specified by:

stop in interface IClientRouter

sendMessageAndGetCompletable

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

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

Specified by:

sendMessageAndGetCompletable in interface IClientRouter

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.

sendMessage

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

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

Specified by:

sendMessage in interface IClientRouter

Parameters:

ctx - The context to send the message under.

message - The message to send.

sendResponseToServer

public 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.

Specified by:

sendResponseToServer in interface IClientRouter

Parameters:

ctx - Channel handler context to use.

inMsg - Incoming message to respond to.

outMsg - Outgoing message.

completeRequest

public <T> void completeRequest(long requestId,
                                T completion)

Complete a given outstanding request with a completion value.

Specified by:

completeRequest in interface IClientRouter

Type Parameters:

T - The type of the completion.

Parameters:

requestId - The request to complete.

completion - The value to complete the request with

completeExceptionally

public void completeExceptionally(long requestID,
                                  @Nonnull
                                  Throwable cause)

Exceptionally complete a request with a given cause.

Specified by:

completeExceptionally in interface IClientRouter

Parameters:

requestID - The request to complete.

cause - The cause to give for the exceptional completion.

channelRead0

protected void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
                            CorfuMsg m)
                     throws Exception

Specified by:

channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<CorfuMsg>

Throws:

Exception

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Specified by:

exceptionCaught in interface io.netty.channel.ChannelInboundHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter

userEventTriggered

public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
                               Object evt)
                        throws Exception

Specified by:

userEventTriggered in interface io.netty.channel.ChannelInboundHandler

Overrides:

userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

getPort

@Deprecated
public Integer getPort()

Deprecated.

Description copied from interface: IClientRouter

The port that this router is routing requests for.

Specified by:

getPort in interface IClientRouter

getHost

@Deprecated
public String getHost()

Deprecated.

Description copied from interface: IClientRouter

The host that this router is routing requests for.

Specified by:

getHost in interface IClientRouter