src/MassTransit.Abstractions/SagaStateMachine/StateMachine.cs - develop - vshmidt/masstransit

src/MassTransit.Abstractions/SagaStateMachine/StateMachine.cs

112 строк3 KB

Chris Patterson

Huge push towards optimization on startup, state machines, type discovery, caching, and the consume pipeline. Rebuilt the dispatch filter as a consume context filter for message type dispatch.

27 мар 2024, 02:43

27 мар 2024, 02:43c17b1de

namespace MassTransit
{
    using System;
    using System.Collections.Generic;
    using System.Threading.Tasks;


    /// <summary>
    /// A state machine definition
    /// </summary>
    public interface StateMachine :
        IVisitable
    {
        /// <summary>
        /// The name of the state machine (defaults to the state machine type name)
        /// </summary>
        string Name { get; }

        /// <summary>
        /// The events defined in the state machine
        /// </summary>
        IEnumerable<Event> Events { get; }

        /// <summary>
        /// The states defined in the state machine
        /// </summary>
        IEnumerable<State> States { get; }

        /// <summary>
        /// The instance type associated with the state machine
        /// </summary>
        Type InstanceType { get; }

        /// <summary>
        /// The initial state of a new state machine instance
        /// </summary>
        State Initial { get; }

        /// <summary>
        /// The final state of a state machine instance
        /// </summary>
        State Final { get; }

        /// <summary>
        /// Returns the event requested
        /// </summary>
        /// <param name="name"></param>
        /// <returns></returns>
        Event GetEvent(string name);

        /// <summary>
        /// Returns the state requested
        /// </summary>
        /// <param name="name"></param>
        /// <returns></returns>
        State GetState(string name);

        /// <summary>
        /// The valid events that can be raised during the specified state
        /// </summary>
        /// <param name="state">The state to query</param>
        /// <returns>An enumeration of valid events</returns>
        IEnumerable<Event> NextEvents(State state);

        /// <summary>
        /// Returns true if the event is or is used by a composite event
        /// </summary>
        /// <param name="event"></param>
        /// <returns></returns>
        bool IsCompositeEvent(Event @event);
    }


    /// <summary>
    /// A defined state machine that operations against the specified instance
    /// </summary>
    /// <typeparam name="TSaga"></typeparam>
    public interface StateMachine<TSaga> :
        StateMachine
        where TSaga : class, SagaStateMachineInstance
    {
        /// <summary>
        /// Exposes the current state on the given instance
        /// </summary>
        IStateAccessor<TSaga> Accessor { get; }

        /// <summary>
        /// Returns the state requested bound to the instance
        /// </summary>
        /// <param name="name"></param>
        /// <returns></returns>
        new State<TSaga> GetState(string name);

        /// <summary>
        /// Raise a simple event on the state machine instance asynchronously
        /// </summary>
        /// <param name="context"></param>
        /// <returns>Task for the instance once completed</returns>
        Task RaiseEvent(BehaviorContext<TSaga> context);

        /// <summary>
        /// Raise a data event on the state machine instance
        /// </summary>
        /// <param name="context"></param>
        Task RaiseEvent<T>(BehaviorContext<TSaga, T> context)
            where T : class;

        IDisposable ConnectEventObserver(IEventObserver<TSaga> observer);
        IDisposable ConnectEventObserver(Event @event, IEventObserver<TSaga> observer);
        IDisposable ConnectStateObserver(IStateObserver<TSaga> observer);
    }
}