alluxio.client.file.dora.netty

Class NettyDataReaderStateMachine

java.lang.Object

alluxio.client.file.dora.netty.NettyDataReaderStateMachine

@NotThreadSafe
public class NettyDataReaderStateMachine
extends Object

State machine of Netty Client.
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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NettyDataReaderStateMachine.TriggerEvent Trigger event definition for NettyClientStateMachine.
static class	NettyDataReaderStateMachine.TriggerEventsWithParam Trigger event with parameters for @{NettyClientStateMacine}.

Constructor Summary

Constructors

Constructor and Description
NettyDataReaderStateMachine(FileSystemContext context, WorkerNetAddress address, Protocol.ReadRequest.Builder requestBuilder, ReadTargetBuffer buffer) Constructor.

Method Summary

Modifier and Type	Method and Description
void	fireNext(NettyDataReaderStateMachine.TriggerEvent triggerEvent) Helper method to allow firing triggers within state handler methods.
<Arg0T> void	fireNext(com.github.oxo42.stateless4j.triggers.TriggerWithParameters1<Arg0T,NettyDataReaderStateMachine.TriggerEvent> triggerEvent, Arg0T arg0) Helper method to allow firing triggers within state handler methods.
void	generateStateDiagram(Path outputFile) Generates a diagram describing the state transition in a .dot file.
int	getBytesRead() Gets the number of bytes that has been received and written into the output channel.
PartialReadException	getException() Gets the exception during execution.
NettyDataReaderStateMachine.TriggerEventsWithParam	getTriggerEventsWithParam() Get the TriggerEventsWithParam.
void	run() Starts the state machine.

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyDataReaderStateMachine

public NettyDataReaderStateMachine(FileSystemContext context,
                                   WorkerNetAddress address,
                                   Protocol.ReadRequest.Builder requestBuilder,
                                   ReadTargetBuffer buffer)

Constructor.

Parameters:

context -

address -

requestBuilder -

buffer -

Method Detail

fireNext

public void fireNext(NettyDataReaderStateMachine.TriggerEvent triggerEvent)

Helper method to allow firing triggers within state handler methods. If the triggers are fired directly within state handler methods, they will likely make recursive calls and blow up the stack.

Parameters:

triggerEvent - the next trigger event to fire

fireNext

public <Arg0T> void fireNext(com.github.oxo42.stateless4j.triggers.TriggerWithParameters1<Arg0T,NettyDataReaderStateMachine.TriggerEvent> triggerEvent,
                             Arg0T arg0)

Helper method to allow firing triggers within state handler methods. If the triggers are fired directly within state handler methods, they will likely make recursive calls and blow up the stack.

Type Parameters:

Arg0T - the type of the argument to be used

Parameters:

triggerEvent - the next trigger event to fire

arg0 - the argument to be used

getTriggerEventsWithParam

public NettyDataReaderStateMachine.TriggerEventsWithParam getTriggerEventsWithParam()

Get the TriggerEventsWithParam.

Returns:

the TriggerEventsWithParam object

run

public void run()

Starts the state machine.

getBytesRead

public int getBytesRead()

Gets the number of bytes that has been received and written into the output channel.

Returns:

number of bytes read

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

getException

@Nullable
public PartialReadException getException()

Gets the exception during execution.

Returns:

exception, or null if there is none