Interface IFlowModule

Base class for all modules.

Inherited Members

System.IDisposable.Dispose()

Namespace: Crosser.EdgeNode.Flows.Abstractions.IFlowModule

Assembly: Crosser.EdgeNode.Flows.Abstractions.dll

Syntax

public interface IFlowModule : IDisposable

Properties

Categories

Declaration

List<string> Categories { get; set; }

Property Value

System.Collections.Generic.List<System.String>

Debug

Declaration

bool Debug { get; set; }

Property Value

System.Boolean

Disabled

Declaration

bool Disabled { get; set; }

Property Value

System.Boolean

FlowContext

Declaration

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

Property Value

Crosser.EdgeNode.Common.Abstractions.Utilities.Persistence.RepositoryInstance<System.String, System.Object>

FlowId

Declaration

Guid FlowId { get; set; }

Property Value

System.Guid

FlowStatistics

Declaration

[JsonIgnore]
FlowStatistics FlowStatistics { get; set; }

Property Value

FlowStatistics

HaltOnError

Declaration

bool HaltOnError { get; set; }

Property Value

System.Boolean

HasInput

Declaration

bool HasInput { get; set; }

Property Value

System.Boolean

HasOutput

Declaration

bool HasOutput { get; }

Property Value

System.Boolean

Id

Declaration

Guid Id { get; set; }

Property Value

System.Guid

Metadata

Declaration

Dictionary<string, dynamic> Metadata { get; set; }

Property Value

System.Collections.Generic.Dictionary<System.String, System.Object>

ModuleProtocol

Declaration

FlowModuleProtocol ModuleProtocol { get; set; }

Property Value

FlowModuleProtocol

ModuleStatistics

Declaration

[JsonIgnore]
FlowModuleStatistics ModuleStatistics { get; set; }

Property Value

FlowModuleStatistics

ModuleType

Declaration

FlowModuleType ModuleType { get; set; }

Property Value

FlowModuleType

ModuleVersion

Declaration

string ModuleVersion { get; set; }

Property Value

System.String

Name

Declaration

string Name { get; set; }

Property Value

System.String

OnDebug

Declaration

[JsonIgnore]
EventHandler<ModuleDebugMessage> OnDebug { get; set; }

Property Value

System.EventHandler<Crosser.EdgeNode.Flows.Abstractions.Models.Messaging.ModuleDebugMessage>

OnError

Declaration

[JsonIgnore]
EventHandler<FlowModuleException> OnError { get; set; }

Property Value

System.EventHandler<FlowModuleException>

OnFlowDataReceived

Declaration

[JsonIgnore]
EventHandler<FlowStatisticsData> OnFlowDataReceived { get; set; }

Property Value

System.EventHandler<Crosser.EdgeNode.Flows.Abstractions.Models.Messaging.FlowStatisticsData>

OnFlowDataSent

Declaration

[JsonIgnore]
EventHandler<FlowStatisticsData> OnFlowDataSent { get; set; }

Property Value

System.EventHandler<Crosser.EdgeNode.Flows.Abstractions.Models.Messaging.FlowStatisticsData>

OnModuleDataReceived

Declaration

[JsonIgnore]
EventHandler<FlowModuleStatisticsData> OnModuleDataReceived { get; set; }

Property Value

System.EventHandler<Crosser.EdgeNode.Flows.Abstractions.Models.Messaging.FlowModuleStatisticsData>

OnModuleDataSent

Declaration

[JsonIgnore]
EventHandler<FlowModuleStatisticsData> OnModuleDataSent { get; set; }

Property Value

System.EventHandler<Crosser.EdgeNode.Flows.Abstractions.Models.Messaging.FlowModuleStatisticsData>

OnStatusChanged

Declaration

[JsonIgnore]
EventHandler<FlowStatusEvent> OnStatusChanged { get; set; }

Property Value

System.EventHandler<Crosser.EdgeNode.Flows.Abstractions.FlowStatusEvent>

OnTimeSeriesDataSent

Declaration

[JsonIgnore]
EventHandler<TimeSeriesDataValues> OnTimeSeriesDataSent { get; set; }

Property Value

System.EventHandler<Crosser.EdgeNode.Flows.Abstractions.Models.Messaging.TimeSeriesDataValues>

OnWarning

Declaration

[JsonIgnore]
EventHandler<FlowModuleException> OnWarning { get; set; }

Property Value

System.EventHandler<FlowModuleException>

Outputs

Declaration

List<RepositoryInstance<Guid, IFlowModule>> Outputs { get; set; }

Property Value

System.Collections.Generic.List<Crosser.EdgeNode.Common.Abstractions.Utilities.Persistence.RepositoryInstance<System.Guid, IFlowModule>>

ReceivesInputFromMultipleModules

Declaration

bool ReceivesInputFromMultipleModules { get; set; }

Property Value

System.Boolean

RemoteSessionEnabled

Declaration

bool RemoteSessionEnabled { get; set; }

Property Value

System.Boolean

Resources

Declaration

IList<ResourceBase> Resources { get; set; }

Property Value

System.Collections.Generic.IList<Crosser.EdgeNode.Flows.Abstractions.Models.Resources.ResourceBase>

Settings

Declaration

FlowModuleSettings Settings { get; }

Property Value

FlowModuleSettings

Status

Declaration

Status Status { get; }

Property Value

Status

Topic

Declaration

string Topic { get; }

Property Value

System.String

Type

Declaration

string Type { get; }

Property Value

System.String

UserFriendlyName

Declaration

string UserFriendlyName { get; }

Property Value

System.String

Methods

CanStart()

Declaration

IError CanStart()

Returns

IError

Initialize()

Declaration

Task<IError> Initialize()

Returns

System.Threading.Tasks.Task<IError>

LoadSettings(String)

Declaration

void LoadSettings(string settingsAsJson)

Parameters

System.String settingsAsJson

Receive(IFlowMessage)

Declaration

Task Receive(IFlowMessage msg)

Parameters

IFlowMessage msg

Returns

System.Threading.Tasks.Task

ReceiveFrom(IFlowModule, Int32)

Declaration

IFlowModule ReceiveFrom(IFlowModule module, int ix = 0)

Parameters

IFlowModule module

System.Int32 ix

Returns

IFlowModule

SendTo(IFlowModule, Int32)

Declaration

IFlowModule SendTo(IFlowModule module, int ix = 0)

Parameters

IFlowModule module

System.Int32 ix

Returns

IFlowModule

SetStatus(Status)

Declaration

void SetStatus(Status status)

Parameters

Status status

SetStatus(Status, String)

Declaration

void SetStatus(Status status, string message)

Parameters

Status status

System.String message

SetStatus(Status, String, Boolean)

Declaration

void SetStatus(Status status, string message, bool force = false)

Parameters

Status status

System.String message

System.Boolean force

Start()

Declaration

Task<IError> Start()

Returns

System.Threading.Tasks.Task<IError>

Stop()

Declaration

Task Stop()

Returns

System.Threading.Tasks.Task

ValidateSettings(SettingsValidator)

Declaration

void ValidateSettings(SettingsValidator validator)

Parameters

SettingsValidator validator