C# Class Ensage.Common.Signals.Signal

A signal.

Inheritance: System.EventArgs

Mostra file Open project: EnsageSharp/Ensage.Common Class Usage Examples

Private Properties

Property	Type	Description
Signal	System
TriggerEnabledStatusChanged	void
TriggerOnExipired	void
TriggerSignal	void

Public Methods

Method	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

Method	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 method

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
return	Signal

Disable() public method

Disables this signal.

public Disable ( ) : void
return	void

Enable() public method

Enables this signal.

public Enable ( ) : void
return	void

Raise() public method

Raises the signal.

public Raise ( Exception exception ) : void
exception	System.Exception	The exception.
return	void

Raise() public method

Raises the signal.

public Raise ( string reason ) : void
reason	string	The reason.
return	void

Reset() public method

Resets the signal.

public Reset ( ) : void
return	void