Package org.drasyl.peer.connection.handler

Class AbstractThreeWayHandshakeServerHandler<R extends RequestMessage,O extends ResponseMessage<?>>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<I>

org.drasyl.peer.connection.handler.SimpleChannelDuplexHandler<Message,Message>

org.drasyl.peer.connection.handler.AbstractThreeWayHandshakeServerHandler<R,O>

All Implemented Interfaces:

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

Direct Known Subclasses:

ServerConnectionHandler

public abstract class AbstractThreeWayHandshakeServerHandler<R extends RequestMessage,O extends ResponseMessage<?>>
extends SimpleChannelDuplexHandler<Message,Message>

This handler performs the server-side part of a three-way handshake to create a session. It waits for a request message for a new session from the client. The request is then confirmed by sending an offer message to the client. It then waits for the client to confirm the offer.

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	Description
protected CompletableFuture<Void>	handshakeFuture
protected Messenger	messenger
protected Duration	timeout
protected io.netty.util.concurrent.ScheduledFuture<?>	timeoutFuture

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractThreeWayHandshakeServerHandler(Duration timeout, Messenger messenger)
protected	AbstractThreeWayHandshakeServerHandler(Duration timeout, Messenger messenger, CompletableFuture<Void> handshakeFuture, io.netty.util.concurrent.ScheduledFuture<?> timeoutFuture, R requestMessage, O offerMessage)

Method Summary

Modifier and Type	Method	Description
void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
void	channelRead0(io.netty.channel.ChannelHandlerContext ctx, Message msg)	Is called for each message of type SimpleChannelDuplexHandler on inbound channel.
protected void	channelWrite0(io.netty.channel.ChannelHandlerContext ctx, Message msg, io.netty.channel.ChannelPromise promise)	Is called for each message of type SimpleChannelDuplexHandler on the outbound channel.
void	close(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)
protected abstract void	createConnection(io.netty.channel.ChannelHandlerContext ctx, R requestMessage)
protected void	doHandshake(io.netty.channel.ChannelHandlerContext ctx, Message message)
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
protected abstract org.slf4j.Logger	getLogger()
protected abstract O	offerSession(io.netty.channel.ChannelHandlerContext ctx, R requestMessage)
protected void	processMessageAfterHandshake(io.netty.channel.ChannelHandlerContext ctx, Message message)
protected void	processUnexpectedMessageDuringHandshake(io.netty.channel.ChannelHandlerContext ctx, Message message)
protected void	rejectSession(io.netty.channel.ChannelHandlerContext ctx, ConnectionExceptionMessage.Error error)
protected void	startTimeoutGuard(io.netty.channel.ChannelHandlerContext ctx)
protected abstract ConnectionExceptionMessage.Error	validateSessionRequest(R requestMessage)

Methods inherited from class org.drasyl.peer.connection.handler.SimpleChannelDuplexHandler

acceptOutboundMessage, bind, connect, deregister, disconnect, flush, read, write

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelInactive, 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

Field Detail

timeout

protected final Duration timeout

handshakeFuture

protected final CompletableFuture<Void> handshakeFuture

messenger

protected final Messenger messenger

timeoutFuture

protected io.netty.util.concurrent.ScheduledFuture<?> timeoutFuture

Constructor Detail

AbstractThreeWayHandshakeServerHandler

protected AbstractThreeWayHandshakeServerHandler(Duration timeout,
                                                 Messenger messenger)

AbstractThreeWayHandshakeServerHandler

protected AbstractThreeWayHandshakeServerHandler(Duration timeout,
                                                 Messenger messenger,
                                                 CompletableFuture<Void> handshakeFuture,
                                                 io.netty.util.concurrent.ScheduledFuture<?> timeoutFuture,
                                                 R requestMessage,
                                                 O offerMessage)

Method Detail

doHandshake

protected void doHandshake(io.netty.channel.ChannelHandlerContext ctx,
                           Message message)

validateSessionRequest

protected abstract ConnectionExceptionMessage.Error validateSessionRequest(R requestMessage)

offerSession

protected abstract O offerSession(io.netty.channel.ChannelHandlerContext ctx,
                                  R requestMessage)

createConnection

protected abstract void createConnection(io.netty.channel.ChannelHandlerContext ctx,
                                         R requestMessage)

processUnexpectedMessageDuringHandshake

protected void processUnexpectedMessageDuringHandshake(io.netty.channel.ChannelHandlerContext ctx,
                                                       Message message)

getLogger

protected abstract org.slf4j.Logger getLogger()

channelRead0

public void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
                         Message msg)

Description copied from class: SimpleChannelDuplexHandler

Is called for each message of type SimpleChannelDuplexHandler on inbound channel.

Specified by:

channelRead0 in class SimpleChannelDuplexHandler<Message,Message>

Parameters:

ctx - the ChannelHandlerContext which this SimpleChannelDuplexHandler belongs to

msg - the message to handle

close

public void close(io.netty.channel.ChannelHandlerContext ctx,
                  io.netty.channel.ChannelPromise promise)
           throws Exception

Specified by:

close in interface io.netty.channel.ChannelOutboundHandler

Overrides:

close in class SimpleChannelDuplexHandler<Message,Message>

Throws:

Exception

channelWrite0

protected void channelWrite0(io.netty.channel.ChannelHandlerContext ctx,
                             Message msg,
                             io.netty.channel.ChannelPromise promise)

Description copied from class: SimpleChannelDuplexHandler

Is called for each message of type SimpleChannelDuplexHandler on the outbound channel.

Specified by:

channelWrite0 in class SimpleChannelDuplexHandler<Message,Message>

Parameters:

ctx - the ChannelHandlerContext which this SimpleChannelDuplexHandler belongs to

msg - the message to handle

promise - the corresponding promise

processMessageAfterHandshake

protected void processMessageAfterHandshake(io.netty.channel.ChannelHandlerContext ctx,
                                            Message message)

channelActive

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

Specified by:

channelActive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

startTimeoutGuard

protected void startTimeoutGuard(io.netty.channel.ChannelHandlerContext ctx)

rejectSession

protected void rejectSession(io.netty.channel.ChannelHandlerContext ctx,
                             ConnectionExceptionMessage.Error error)

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