C# Class Ensage.Common.Signals.Signal

A signal.
Inheritance: System.EventArgs
Afficher le fichier Open project: EnsageSharp/Ensage.Common Class Usage Examples

Private Properties

Свойство Type Description
Signal System
TriggerEnabledStatusChanged void
TriggerOnExipired void
TriggerSignal void

Méthodes publiques

Méthode Description
Create ( OnRaisedDelegate onRaised = null, SignalWaverDelegate signalWaver = null, DateTimeOffset expiration = default(DateTimeOffset), object>.IDictionary defaultProperties = null ) : Signal

Creates an instance of the Signal class.

Disable ( ) : void

Disables this signal.

Enable ( ) : void

Enables this signal.

Raise ( Exception exception ) : void

Raises the signal.

Raise ( string reason ) : void

Raises the signal.

Reset ( ) : void

Resets the signal.

Private Methods

Méthode Description
Signal ( OnRaisedDelegate signalRaised, SignalWaverDelegate signalWaver, DateTimeOffset expiration, object>.IDictionary properties ) : System

Initializes a new instance of the Signal class.

TriggerEnabledStatusChanged ( object sender, bool enabled ) : void

Triggers the enabled status changed event.

TriggerOnExipired ( object sender ) : void

Triggers the on expired event.

TriggerSignal ( object sender, string reason ) : void

Triggers the signal.

Method Details

Create() public static méthode

Creates an instance of the Signal class.
public static Create ( OnRaisedDelegate onRaised = null, SignalWaverDelegate signalWaver = null, DateTimeOffset expiration = default(DateTimeOffset), object>.IDictionary defaultProperties = null ) : Signal
onRaised OnRaisedDelegate The delegate to call when this signal is raised.
signalWaver SignalWaverDelegate The function that returns true when this signal should be waved.
expiration DateTimeOffset The expiration of this signal.
defaultProperties object>.IDictionary A dictionary that contents will be dumped into
Résultat Signal

Disable() public méthode

Disables this signal.
public Disable ( ) : void
Résultat void

Enable() public méthode

Enables this signal.
public Enable ( ) : void
Résultat void

Raise() public méthode

Raises the signal.
public Raise ( Exception exception ) : void
exception System.Exception The exception.
Résultat void

Raise() public méthode

Raises the signal.
public Raise ( string reason ) : void
reason string The reason.
Résultat void

Reset() public méthode

Resets the signal.
public Reset ( ) : void
Résultat void