Simple state machine implementation in C# (.NET 6).
Advantages:
- DI ready
- Async Pattern
- Safe programming with nullable types
- Works without constants and enums
- Builder for state machine creation
- Configuration of states and transitions
- Strict (default) and open transitions
- more than 95% code coverage
You should install BlackMali.StateMachine with NuGet:
Install-Package BlackMali.StateMachine
Or via the .NET Core command line interface:
dotnet add package BlackMali.StateMachine
public class SlotMachine
{
private readonly IStateMachine _stateMachine;
public SlotMachine(IStateMachineBuilder builder)
{
// With registration -> AddState<LockState>()
builder.AddState<LockState>()
.AddStartTransition();
.AddInStateTransition()
.AddTransition<UnLockState>()
.AddTransition<EndState>();
// Without registration -> AddState(new UnLockState())
builder.AddState(new UnLockState())
.AddInStateTransition()
.AddTransition<LockState>()
.AddTransition<EndState>();
// Create state machine
_stateMachine = builder.Build();
}
}await machine.Transmit<LockState>();
// OR with Event
await machine.Transmit<LockState>(new StateMachineEvent());
// Posts an event to the current status
await machine.Post(new StateMachineEvent());internal class LockState
: State // you can also use the interface IState without overrides
{
// optional:
public override async Task OnEnter(IStateMachineContext context)
{
await base.OnEnter(context);
Console.WriteLine("Please insert coin");
}
// optional:
public override async Task<IState?> OnTransmitted(IStateMachineContext context, StateMachineEvent @event)
{
var unLockEvent = @event as UnLockEvent;
if (unLockEvent == null)
return null;
// No state change...
if (unLockEvent.Coin == null)
return null;
// State change to UnLockState
return await context.GetState<UnLockState>();
}
// optional:
public override async Task OnExit(IStateMachineContext context)
{
// Do something...
await Task.CompletedTask;
}
}No Packages required
- XUnit
- XUnit.Runner.VisualStudio
- Autofac.Extras.Moq
- Moq
- Coverlet.Collector
Implemented with Microsoft Visual Studio Community 2022