Unosquare
    Show / Hide Table of Contents

    Class TimerWorkerBase

    Provides a base implementation for application workers.

    Inheritance
    Object
    WorkerBase
    TimerWorkerBase
    Implements
    IWorker
    IDisposable
    Inherited Members
    WorkerBase.Name
    WorkerBase.Period
    WorkerBase.WorkerState
    WorkerBase.IsDisposed
    WorkerBase.IsDisposing
    WorkerBase.DefaultPeriod
    WorkerBase.IsStopRequested
    WorkerBase.CycleStopwatch
    WorkerBase.StateChangeRequests
    WorkerBase.CycleCompletedEvent
    WorkerBase.StateChangedEvent
    WorkerBase.CycleCancellation
    WorkerBase.StateChangeTask
    WorkerBase.Dispose()
    WorkerBase.OnCycleException(Exception)
    WorkerBase.ExecuteCycleLogic(CancellationToken)
    WorkerBase.OnDisposing()
    WorkerBase.OnStateChangeProcessed(WorkerState, WorkerState)
    WorkerBase.ComputeCycleDelay(WorkerState)
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Swan.Threading
    Syntax
    public abstract class TimerWorkerBase : WorkerBase, IWorker, IDisposable

    Constructors

    TimerWorkerBase(String, TimeSpan)

    Initializes a new instance of the TimerWorkerBase class.

    Declaration
    protected TimerWorkerBase(string name, TimeSpan period)
    Parameters
    Type Name Description
    String name

    The name.

    TimeSpan period

    The execution interval.

    Methods

    Dispose(Boolean)

    Releases unmanaged and - optionally - managed resources.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    Boolean disposing

    true to release both managed and unmanaged resources; false to release only unmanaged resources.

    Overrides
    WorkerBase.Dispose(Boolean)

    PauseAsync()

    Declaration
    public override Task<WorkerState> PauseAsync()
    Returns
    Type Description
    Task<WorkerState>
    Overrides
    WorkerBase.PauseAsync()

    ResumeAsync()

    Declaration
    public override Task<WorkerState> ResumeAsync()
    Returns
    Type Description
    Task<WorkerState>
    Overrides
    WorkerBase.ResumeAsync()

    ScheduleCycle(Int32)

    Schedules a new cycle for execution. The delay is given in milliseconds. Passing a delay of 0 means a new cycle should be executed immediately.

    Declaration
    protected void ScheduleCycle(int delay)
    Parameters
    Type Name Description
    Int32 delay

    The delay.

    StartAsync()

    Declaration
    public override Task<WorkerState> StartAsync()
    Returns
    Type Description
    Task<WorkerState>
    Overrides
    WorkerBase.StartAsync()

    StopAsync()

    Declaration
    public override Task<WorkerState> StopAsync()
    Returns
    Type Description
    Task<WorkerState>
    Overrides
    WorkerBase.StopAsync()

    Implements

    IWorker
    System.IDisposable

    See Also

    IWorker

    Comments

    Back to top Copyright © 2017-2019 Unosquare