org.corfudb.infrastructure

Class CorfuMsgHandler

java.lang.Object

org.corfudb.infrastructure.CorfuMsgHandler

public class CorfuMsgHandler
extends Object

This class implements message handlers for AbstractServer implementations. Servers define methods with signatures which follow the signature of the Handler functional interface, and generate a handler using the this#generateHandler(MethodHandles.Lookup, AbstractServer) method.

For maximum performance, make the handlers static whenever possible. Handlers should be as short as possible (not block), since handler threads come from a shared pool used by all servers. Blocking operations should be offloaded to I/O threads.

Created by mwei on 7/26/16.

Constructor Summary

Constructors

Constructor and Description
CorfuMsgHandler() Construct a new instance of CorfuMsgHandler.

Method Summary

Modifier and Type	Method and Description
<T extends CorfuMsg> CorfuMsgHandler	addHandler(CorfuMsgType messageType, org.corfudb.infrastructure.CorfuMsgHandler.Handler<T> handler) Add a handler to this message handler.
static CorfuMsgHandler	generateHandler(MethodHandles.Lookup caller, AbstractServer server) Generate handlers for a particular server.
Set<CorfuMsgType>	getHandledTypes() Get the types this handler will handle.
org.corfudb.infrastructure.CorfuMsgHandler.Handler<CorfuMsg>	getHandler(CorfuMsgType type) Get a handler for a specific message type.
boolean	handle(CorfuMsg message, io.netty.channel.ChannelHandlerContext ctx, IServerRouter r) Handle an incoming CorfuMsg.

Methods inherited from class java.lang.Object

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

Constructor Detail

CorfuMsgHandler

public CorfuMsgHandler()

Construct a new instance of CorfuMsgHandler.

Method Detail

getHandledTypes

public Set<CorfuMsgType> getHandledTypes()

Get the types this handler will handle.

Returns:

A set containing the types this handler will handle.

getHandler

public org.corfudb.infrastructure.CorfuMsgHandler.Handler<CorfuMsg> getHandler(CorfuMsgType type)

Get a handler for a specific message type.

Parameters:

type - The type to retrieve a handler for.

Returns:

A handler for the requested message type.

addHandler

public <T extends CorfuMsg> CorfuMsgHandler addHandler(CorfuMsgType messageType,
                                                       org.corfudb.infrastructure.CorfuMsgHandler.Handler<T> handler)

Add a handler to this message handler.

Type Parameters:

T - A CorfuMsg type.

Parameters:

messageType - The type of CorfuMsg this handler will handle.

handler - The handler itself.

Returns:

This handler, to support chaining.

handle

public boolean handle(CorfuMsg message,
                      io.netty.channel.ChannelHandlerContext ctx,
                      IServerRouter r)

Handle an incoming CorfuMsg.

Parameters:

message - The message to handle.

ctx - The channel handler context.

r - The server router.

Returns:

True, if the message was handled. False otherwise.

generateHandler

public static CorfuMsgHandler generateHandler(@Nonnull
                                              MethodHandles.Lookup caller,
                                              @Nonnull
                                              AbstractServer server)

Generate handlers for a particular server.

Parameters:

caller - The context that is being used. Call MethodHandles.lookup() to obtain.

server - The object that implements the server.

Returns:

New message handler for caller class