Class Flow

Namespace

Crosser.EdgeNode.Flows

Assembly

Crosser.EdgeNode.Flows.dll

public class Flow : FlowBase, IDisposable

Inheritance

object

FlowBase

Flow

Implements

IDisposable

Inherited Members

FlowBase.Name

FlowBase.FlowVersion

FlowBase.Description

FlowBase.Id

FlowBase.FlowDefinitionId

FlowBase.FlowDeploymentId

FlowBase.ResolveFlowDeploymentId

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Flow()

Default constructor

public Flow()

Properties

CalculateTotalTimeoutForStartup

public int CalculateTotalTimeoutForStartup { get; }

Property Value

int

DisableQueues

If true no channels will be used for queueing messages internally in the module Persistence and retry will also be disabled if queues are disabled

public bool DisableQueues { get; set; }

Property Value

bool

EnabledModules

[JsonIgnore]
public IEnumerable<FlowModule> EnabledModules { get; }

Property Value

IEnumerable<FlowModule>

FlowContext

Context for the flow

[JsonIgnore]
public RepositoryInstance<string, dynamic> FlowContext { get; }

Property Value

RepositoryInstance<string, dynamic>

FlowState

Current FlowState of the flow

public virtual FlowState FlowState { get; set; }

Property Value

FlowState

HaltOnError

If true the flow will be stopped if an error occurs

public bool HaltOnError { get; set; }

Property Value

bool

IsCancellationRequested

public bool IsCancellationRequested { get; }

Property Value

bool

Modules

[JsonConverter(typeof(FlowModuleJsonConverter))]
public List<FlowModule> Modules { get; set; }

Property Value

List<FlowModule>

OnFlowException

[JsonIgnore]
public EventHandler<FlowException>? OnFlowException { get; set; }

Property Value

EventHandler<FlowException>

OnMessageDeadLetter

[JsonIgnore]
public EventHandler<MessageEvent>? OnMessageDeadLetter { get; set; }

Property Value

EventHandler<MessageEvent>

OnMessageDropped

[JsonIgnore]
public EventHandler<MessageEvent>? OnMessageDropped { get; set; }

Property Value

EventHandler<MessageEvent>

OnModuleDebugMessage

[JsonIgnore]
public EventHandler<ModuleDebugMessage>? OnModuleDebugMessage { get; set; }

Property Value

EventHandler<ModuleDebugMessage>

OnModuleStatusChanged

[JsonIgnore]
public EventHandler<ModuleStatusEvent>? OnModuleStatusChanged { get; set; }

Property Value

EventHandler<ModuleStatusEvent>

RemoteSessionEnabled

True when debug data should be sent to cloud

[JsonIgnore]
public bool RemoteSessionEnabled { get; }

Property Value

bool

Resources

The resources used on the flow

public List<ResourceBase> Resources { get; set; }

Property Value

List<ResourceBase>

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

EnableRemoteSession()

public void EnableRemoteSession()

Start()

public Task<IResult> Start()

Returns

Task<IResult>

StartInteractive()

public Task<IResult> StartInteractive()

Returns

Task<IResult>

Stop()

public Task<IResult> Stop()

Returns

Task<IResult>

ValidateFlow()

public IResult<IList<IValidationError>> ValidateFlow()

Returns

IResult<IList<IValidationError>>