https://github.com/mustaddon/statemachine

.NET Finite-state machine (FSM) with a fluent interface and mediators compatibility
https://github.com/mustaddon/statemachine

csharp dotnet finite-state-machine fluent-fsm fluent-interface fluent-workflow fsm mediator mediatr mediatr-extension state state-machine state-management

Last synced: 5 days ago
JSON representation

.NET Finite-state machine (FSM) with a fluent interface and mediators compatibility

• Host: GitHub
• URL: https://github.com/mustaddon/statemachine
• Owner: mustaddon
• License: mit
• Created: 2019-04-12T14:26:26.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-11-16T11:44:45.000Z (about 2 months ago)
• Last Synced: 2024-12-16T18:11:38.483Z (20 days ago)
• Topics: csharp, dotnet, finite-state-machine, fluent-fsm, fluent-interface, fluent-workflow, fsm, mediator, mediatr, mediatr-extension, state, state-machine, state-management
• Language: C#
• Homepage:
• Size: 508 KB
• Stars: 4
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FluentStateMachine [![NuGet version](https://badge.fury.io/nu/FluentStateMachine.svg)](http://badge.fury.io/nu/FluentStateMachine)

Finite-state machine (FSM) with a fluent interface and mediators compatibility.

## Example

```C#

enum States { S1, S2, S3 }

enum Events { E1, E2, E3 }

```

```C#

var fsm = new FsmBuilder(States.S1)

    .OnEnter(x => Console.WriteLine($"State change to {x.State} from {x.PrevState}"))

    .State(States.S1)

        .On(Events.E1).Execute(x => { /* some operations */ return "some results"; })

        .On(Events.E2).JumpTo(States.S2)

    .State(States.S2)

        .On(Events.E3).Enable(x => /* some conditions */ true).JumpTo(States.S3)

    .State(States.S3)

        .OnEnter(x => Console.WriteLine($"Enter to final state"))

    .Build();

Console.WriteLine(fsm.Trigger(Events.E1));

fsm.Trigger(Event.E2);

fsm.Trigger(Event.E3);

// Console output:

// some results

// State change to S2 from S1

// State change to S3 from S2

// Enter to final state

```

[ReadmeExample1.cs](https://github.com/mustaddon/StateMachine/blob/master/Examples/Example.ConsoleApp/ReadmeExample1.cs)

## Example with type-based events

```C#

class Event1 : IFsmEvent

{

    public int SomeProp { get; set; }

}

class Event2 : IFsmEvent;

class Event3 : IFsmEvent;

```

```C#

var fsm = new FsmBuilder(States.S1)

    .OnEnter(x => Console.WriteLine($"State change to {x.State} from {x.PrevState}"))

    .State(States.S1)

        .On().Execute(x => $"{x.Data.SomeProp} results")

        .On().JumpTo(States.S2)

    .State(States.S2)

        .On().JumpTo(States.S3)

    .State(States.S3)

        .OnEnter(x => Console.WriteLine($"Enter to final state"))

    .Build();

Console.WriteLine(

    fsm.Trigger(new Event1 { 

        SomeProp = 123 

    }));

fsm.Trigger(new Event2());

fsm.Trigger(new Event3());

// Console output:

// 123 results

// State change to S2 from S1

// State change to S3 from S2

// Enter to final state

```

[ReadmeExample2.cs](https://github.com/mustaddon/StateMachine/blob/master/Examples/Example.ConsoleApp/ReadmeExample2.cs)

[Example of use for workflows](https://github.com/mustaddon/StateMachine/blob/master/Examples/Example.ConsoleApp/WorkflowExample.cs)

[Using with MediatR](https://github.com/mustaddon/StateMachine/tree/master/FluentStateMachine.MediatR#fluentstatemachinemediatr-)