Show / Hide Table of Contents

    Class FlowModule<TSettings>

    Base class for all modules with settings.

    Inheritance
    System.Object
    FlowModule
    FlowModule<TSettings>
    FlowModuleWithoutSettings
    Inherited Members
    FlowModule.ReceivesInputFromMultipleModules
    FlowModule.Receive(IFlowMessage)
    FlowModule.ReceiveFrom(IFlowModule, Int32)
    FlowModule.SendTo(IFlowModule, Int32)
    FlowModule.SetStatus(Status)
    FlowModule.SetStatus(Status, String)
    FlowModule.SetStatus(Status, String, Boolean)
    FlowModule.MessageReceived(IFlowMessage)
    FlowModule.Next(IFlowMessage[])
    FlowModule.NoError
    FlowModule.Initialize()
    FlowModule.Start()
    FlowModule.Stop()
    FlowModule.Dispose()
    FlowModule.CanStart()
    FlowModule.SetMetadataValue(String, Object, Boolean)
    FlowModule.UpdateModuleReceivedStatistics(Int64)
    FlowModule.UpdateFlowReceivedStatistics(Int64)
    FlowModule.UpdateModuleSentStatistics(Int64)
    FlowModule.UpdateFlowSentStatistics(Int64)
    FlowModule.OnStatusChanged
    FlowModule.OnError
    FlowModule.OnWarning
    FlowModule.OnDebug
    FlowModule.OnModuleDataReceived
    FlowModule.OnFlowDataReceived
    FlowModule.OnModuleDataSent
    FlowModule.OnFlowDataSent
    FlowModule.OnTimeSeriesDataSent
    FlowModule.ModuleVersion
    FlowModule.Status
    FlowModule.Resources
    FlowModule.ModuleStatistics
    FlowModule.FlowStatistics
    FlowModule.RemoteSessionEnabled
    FlowModule.FlowContext
    FlowModule.Metadata
    FlowModule.ModuleType
    FlowModule.ModuleProtocol
    FlowModule.Topic
    FlowModule.Type
    FlowModule.Name
    FlowModule.UserFriendlyName
    FlowModule.Categories
    FlowModule.HasInput
    FlowModule.HasOutput
    FlowModule.HaltOnError
    FlowModule.Disabled
    FlowModule.NrOfOutputs
    FlowModule.SetNrOfOutputs(Int32)
    FlowModule.MaxNrOfOutputs
    FlowModule.Debug
    FlowModule.Outputs
    FlowModule.FlowId
    FlowModule.Id
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Crosser.EdgeNode.Flows.FlowModule`1
    Assembly: Crosser.EdgeNode.Flows.dll
    Syntax
    public abstract class FlowModule<TSettings> : FlowModule, IFlowModule, IDisposable where TSettings : FlowModuleSettings, new()
    Type Parameters
    TSettings

    The class to use as settings for the module

    Constructors

    FlowModule(FlowModuleType)

    Constructor for FlowModule<TSettings>

    Declaration
    public FlowModule(FlowModuleType moduleType)
    Parameters
    FlowModuleType moduleType

    Properties

    Settings

    Declaration
    public TSettings Settings { get; protected set; }
    Property Value
    TSettings

    Methods

    AllowMessageToEnterModule(IFlowMessage)

    Get the setting class for the module

    Declaration
    protected override bool AllowMessageToEnterModule(IFlowMessage msg)
    Parameters
    IFlowMessage msg

    Returns
    System.Boolean

    The settings class of the type passed in as generic FlowModule<TSettings>

    Overrides
    FlowModule.AllowMessageToEnterModule(IFlowMessage)

    BypassMessageNotMatchingRules()

    Declaration
    protected override bool BypassMessageNotMatchingRules()
    Returns
    System.Boolean

    Overrides
    FlowModule.BypassMessageNotMatchingRules()

    LoadSettings(String)

    Declaration
    public override sealed void LoadSettings(string settingsAsJson)
    Parameters
    System.String settingsAsJson

    Overrides
    FlowModule.LoadSettings(String)

    SendTimeSeriesData(IFlowMessage)

    Declaration
    protected override void SendTimeSeriesData(IFlowMessage msg)
    Parameters
    IFlowMessage msg

    Overrides
    FlowModule.SendTimeSeriesData(IFlowMessage)

    ValidateSettings(SettingsValidator)

    Declaration
    public override sealed void ValidateSettings(SettingsValidator validator)
    Parameters
    SettingsValidator validator

    Overrides
    FlowModule.ValidateSettings(SettingsValidator)
    Back to top Crosser SDK