com.digitalpetri.netty.fsm

Class ChannelFsm

java.lang.Object

com.digitalpetri.netty.fsm.ChannelFsm

public class ChannelFsm
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChannelFsm.TransitionListener

Method Summary

Modifier and Type	Method and Description
void	addTransitionListener(ChannelFsm.TransitionListener transitionListener) Add a ChannelFsm.TransitionListener.
java.util.concurrent.CompletableFuture<io.netty.channel.Channel>	connect() Fire a Event.Connect event and return a CompletableFuture that completes successfully with the Channel if a successful connection is made, or already exists, and completes exceptionally otherwise.
java.util.concurrent.CompletableFuture<java.lang.Void>	disconnect() Fire a Event.Disconnect event and return a CompletableFuture that completes successfully when the Channel has been closed.
java.util.concurrent.CompletableFuture<io.netty.channel.Channel>	getChannel() Fire a Event.GetChannel event and return a CompletableFuture that completes successfully when the Channel is available and completes exceptionally if the FSM is not currently connected or the connection attempt failed.
java.util.concurrent.CompletableFuture<io.netty.channel.Channel>	getChannel(boolean waitForReconnect) Fire a Event.GetChannel event and return a CompletableFuture that completes successfully when the Channel is available and completes exceptionally if the FSM is not currently connected or the connection attempt failed.
State	getState() Get the current State of the ChannelFsm.
void	removeTransitionListener(ChannelFsm.TransitionListener transitionListener) Remove a previously registered ChannelFsm.TransitionListener.

Methods inherited from class java.lang.Object

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

Method Detail

connect

public java.util.concurrent.CompletableFuture<io.netty.channel.Channel> connect()

Fire a Event.Connect event and return a CompletableFuture that completes successfully with the Channel if a successful connection is made, or already exists, and completes exceptionally otherwise.

Returns:

a CompletableFuture that completes successfully with the Channel if a successful connection was made, or already exists, and completes exceptionally otherwise.

disconnect

public java.util.concurrent.CompletableFuture<java.lang.Void> disconnect()

Fire a Event.Disconnect event and return a CompletableFuture that completes successfully when the Channel has been closed.

Returns:

a CompletableFuture that completes successfully when the Channel has been closed.

getChannel

public java.util.concurrent.CompletableFuture<io.netty.channel.Channel> getChannel()

Fire a Event.GetChannel event and return a CompletableFuture that completes successfully when the Channel is available and completes exceptionally if the FSM is not currently connected or the connection attempt failed.

connect() must have been called at least once before attempting to get a Channel. Whether further calls are necessary depends on whether the FSM is configured to be persistent in its connection attempts or not.

The returned CompletableFuture always fails exceptionally if the FSM is not connected.

This method is equivalent to getChannel(true) - if the state machine is reconnecting it will wait for the result.

Returns:

a CompletableFuture that completes successfully when the Channel is available and completes exceptionally if the FSM is not currently connected or the connection attempt failed.

getChannel

public java.util.concurrent.CompletableFuture<io.netty.channel.Channel> getChannel(boolean waitForReconnect)

Fire a Event.GetChannel event and return a CompletableFuture that completes successfully when the Channel is available and completes exceptionally if the FSM is not currently connected or the connection attempt failed.

connect() must have been called at least once before attempting to get a Channel. Whether further calls are necessary depends on whether the FSM is configured to be persistent in its connection attempts or not.

The returned CompletableFuture always fails exceptionally if the FSM is not connected.

Parameters:

waitForReconnect - when true and the state machine is in State.ReconnectWait the future will not be completed until the result of the subsequent reconnect attempt has been obtained. When false and the state machine is in State.ReconnectWait the future is failed immediately. This parameter has no effect in other states.

Returns:

a CompletableFuture that completes successfully when the Channel is available and *completes exceptionally if the FSM is not currently connected or the connection attempt failed.

getState

public State getState()

Get the current State of the ChannelFsm.

Returns:

the current State of the ChannelFsm.

addTransitionListener

public void addTransitionListener(ChannelFsm.TransitionListener transitionListener)

Add a ChannelFsm.TransitionListener.

Parameters:

transitionListener - the ChannelFsm.TransitionListener.

removeTransitionListener

public void removeTransitionListener(ChannelFsm.TransitionListener transitionListener)

Remove a previously registered ChannelFsm.TransitionListener.

Parameters:

transitionListener - the ChannelFsm.TransitionListener.