org.corfudb.protocols.wireprotocol

Class ClientHandshakeHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

org.corfudb.protocols.wireprotocol.ClientHandshakeHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelOutboundHandler

public class ClientHandshakeHandler
extends io.netty.channel.ChannelDuplexHandler

The ClientHandshakeHandler initiates the handshake upon socket connection. - Once the client connects to the server, it sends a handshake message that contains: its own id and the (asserted) server's node id. - The server validates and replies with its node id and current version of Corfu. - If validation is correct on both sides, message exchange is initiated between client-server, otherwise, the handshake times out, and either server or client close the connection. Created by amartinezman on 12/8/17.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientHandshakeHandler.ClientHandshakeEvent Events that the handshaker sends to downstream handlers.

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
ClientHandshakeHandler(UUID clientId, UUID serverId, int handshakeTimeout) Creates a new ClientHandshakeHandler which will handle the handshake between the current client and a remote server.

Method Summary

Modifier and Type	Method and Description
void	channelActive(io.netty.channel.ChannelHandlerContext ctx) Channel event that is triggered when a new connected channel is created.
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx) Channel event that is triggered when the channel is closed.
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object m) Read data from the Channel.
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause) Channel event that is triggered when an exception is caught.
void	write(io.netty.channel.ChannelHandlerContext ctx, Object msg, io.netty.channel.ChannelPromise promise) Channel event that is triggered when an outbound handler attempts to write into the channel.

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

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 io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

ClientHandshakeHandler

public ClientHandshakeHandler(@NonNull
                              UUID clientId,
                              UUID serverId,
                              int handshakeTimeout)

Creates a new ClientHandshakeHandler which will handle the handshake between the current client and a remote server.

Parameters:

clientId - Current Client Identifier.

serverId - Remote Server Identifier to connect to.

Method Detail

channelRead

public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
                        Object m)
                 throws Exception

Read data from the Channel.

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Parameters:

ctx - channel handler context

m - object received in inbound buffer

Throws:

Exception

channelActive

public void channelActive(io.netty.channel.ChannelHandlerContext ctx)
                   throws Exception

Channel event that is triggered when a new connected channel is created.

Specified by:

channelActive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class io.netty.channel.ChannelInboundHandlerAdapter

Parameters:

ctx - channel handler context

Throws:

Exception

channelInactive

public void channelInactive(io.netty.channel.ChannelHandlerContext ctx)
                     throws Exception

Channel event that is triggered when the channel is closed.

Specified by:

channelInactive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelInactive in class io.netty.channel.ChannelInboundHandlerAdapter

Parameters:

ctx - channel handler context

Throws:

Exception

exceptionCaught

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

Channel event that is triggered when an exception is caught.

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

Parameters:

ctx - channel handler context

cause - exception cause

Throws:

Exception

write

public void write(io.netty.channel.ChannelHandlerContext ctx,
                  Object msg,
                  io.netty.channel.ChannelPromise promise)
           throws Exception

Channel event that is triggered when an outbound handler attempts to write into the channel.

Specified by:

write in interface io.netty.channel.ChannelOutboundHandler

Overrides:

write in class io.netty.channel.ChannelDuplexHandler

Parameters:

ctx - channel handler context

msg - message written into channel

promise - channel promise

Throws:

Exception