alluxio.worker.netty

Class NettyReadHandlerStateMachine<ReqT extends ReadRequest>

java.lang.Object

alluxio.worker.netty.NettyReadHandlerStateMachine<ReqT>

Type Parameters:

ReqT - the ReadRequest type

public class NettyReadHandlerStateMachine<ReqT extends ReadRequest>
extends Object

State machine of Netty Server in Alluxio Worker.
You can get a diagram describing the state transitions of this state machine, by calling generateStateDiagram(Path). After you update the states and triggers, create a diagram and check if the new state transitions are properly handled.

Constructor Summary

Constructors

Constructor and Description
NettyReadHandlerStateMachine(io.netty.channel.Channel channel, Class<ReqT> requestType, AbstractReadHandler.PacketReader.Factory<ReqT,? extends AbstractReadHandler.PacketReader<ReqT>> packetReaderFactory) The state machine for reading packet task in Alluxio Worker.

Method Summary

Modifier and Type	Method and Description
void	cancel() Cancel an ongoing read request.
void	generateStateDiagram(Path outputFile) Generates a diagram describing the state transition in a .dot file.
void	notifyChannelClosed() Notifies the state machine that the channel has been closed.
void	notifyChannelException(Throwable channelException) Notify the state machine that a channel exception occur.
void	run() Start the state machine.
void	submitNewRequest(ReqT readRequest) Submits a new read request for processing in the state machine.

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyReadHandlerStateMachine

public NettyReadHandlerStateMachine(io.netty.channel.Channel channel,
                                    Class<ReqT> requestType,
                                    AbstractReadHandler.PacketReader.Factory<ReqT,? extends AbstractReadHandler.PacketReader<ReqT>> packetReaderFactory)

The state machine for reading packet task in Alluxio Worker.

Parameters:

channel - the netty channel

requestType - the type of the request class

packetReaderFactory - the packet reader factory for creating packet readers

Method Detail

generateStateDiagram

public void generateStateDiagram(Path outputFile)
                          throws IOException

Generates a diagram describing the state transition in a .dot file. Only used for testing purposes.

Parameters:

outputFile - path to the output file

Throws:

IOException - when writing file fails

run

public void run()

Start the state machine.

submitNewRequest

public void submitNewRequest(ReqT readRequest)

Submits a new read request for processing in the state machine.

Parameters:

readRequest - read request

cancel

public void cancel()

Cancel an ongoing read request.

notifyChannelException

public void notifyChannelException(Throwable channelException)

Notify the state machine that a channel exception occur.

Parameters:

channelException - the encountered Error object

notifyChannelClosed

public void notifyChannelClosed()

Notifies the state machine that the channel has been closed.