[This is preliminary documentation and is subject to change.]
The Event type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | Event(IEventTimer, IConfigSectionNode) | Initializes a new instance of the Event class |
![]() | Event(IEventTimer, String, TimerEvent, Nullable TimeSpan , IConfigSectionNode, EventBodyAsyncModel, Boolean) | Initializes a new instance of the Event class |
Methods
Name | Description | |
---|---|---|
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | AdjustDate |
Adjusts date time Localized time
|
![]() | Configure | |
![]() | Destructor | (Overrides ApplicationComponent Destructor .) |
![]() | Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
![]() | DoFire | |
![]() | DoHandleError | |
![]() | DoVisit |
Override to perform extra status checks
|
![]() | EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) |
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | ExternalGetParameter |
Gets external parameter value returning true if parameter was found
|
![]() | ExternalParametersForGroups |
Returns named parameters that can be used to control this component
|
![]() | ExternalSetParameter |
Sets external parameter value returning true if parameter was found and set
|
![]() | Finalize | (Inherited from DisposableObject.) |
![]() | Fire |
Calls event regardless of any constraints.
Invokes a handler right away if syncInvoke is true or BodyAsyncModel is Sync,
otherwise queues the task on a thread pool either as a regular or long-running task depending on BodyAsyncModel
|
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | LocalizedTimeToUniversalTime |
Converts localized time to UTC time as of TimeLocation property
|
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | ResetCallCount |
Resets call count counter. If this event has expired it will eventually transition to Started state.
Keep in mind that it may expire again if EndDate is set and past due
|
![]() | ![]() | Returns a string that represents the current object. (Inherited from ![]() |
![]() | UniversalTimeToLocalizedTime |
Converts universal time to local time as of TimeLocation property
|
![]() | VisitAndCheck |
Invoked by timer, checks all conditions and fires/expires event depending on the status.
Returns true if event was fired, false otherwise
|
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() ![]() | CONFIG_EVENT_SECTION | |
![]() ![]() | CONFIG_HANDLER_SECTION | |
![]() | EventHandler |
References event handler that handles events. If it is null then only delegate events are called
|
![]() | m_Lock |
Properties
Name | Description | |
---|---|---|
![]() | BodyAsyncModel |
Defines how event body should be invoked
|
![]() | CallCount |
Returns how many times this event was called
|
![]() | ComponentCommonName |
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations.
This name is searched-by some management tools that allow to find component by this name that does not change between
application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.) |
![]() | ComponentDirector |
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.) |
![]() | ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) |
![]() | ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) |
![]() | Context |
Adds arbitrary context object to the event
|
![]() | Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) |
![]() | DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) |
![]() | Enabled |
Specifies whether this event will fire/participate in timer loop
|
![]() | EndDate |
Specifies when this event will stop firing in the local event time
|
![]() | ExternalParameters |
Returns named parameters that can be used to control this component
|
![]() | Interval |
Specifies how often event fires
|
![]() | LastCall |
Returns when was this event called for the last time in the local event time
|
![]() | LastError |
Returns the last exception thrown from event handler or nul if no error happened
|
![]() | LocalizedTime |
Returns current time localized per TimeLocation
|
![]() | MaxCount |
Specifies how many times this event can be called. If less or equal than zero then no limit is set
|
![]() | Name | |
![]() | StartDate |
Specifies when this event will start firing in the local event time
|
![]() | Status | |
![]() | TimeLocation |
Returns time location that this Event instance operates under.
|
![]() | Timer |
Events
Name | Description | |
---|---|---|
![]() | Body |
Event body that gets called when the event is due. The body is always invoked ASYNCHRONOUSLY
unless Fire(syncronous=true) is called in which case it gets called on a thread that called Fire(true)
|
![]() | DefinitionChange |
Invoked when one of timer event definition parameters changes.
Always called synchronously on the same thread that made a change.
Subscribers should not block for long
|
![]() | StatusChange |
Invoked when timer event status changes. Always called synchronously by the timer thread.
Subscribers should not block for long
|
See Also