pluginbase.Objects.Tasks.RecurringTask Class Reference

Recurring task. Returns true once done More...

Inheritance diagram for pluginbase.Objects.Tasks.RecurringTask:

Public Member Functions
	RecurringTask (Func< TaskResult > method, TimeSpan frequency)
	RecurringTask (Action task, TimeSpan frequency)
TaskResult	InvokeTask (long maxMilliseconds)
override string	ToString ()

Properties
TimeSpan	Frequency [get]
Properties inherited from pluginbase.Objects.Tasks.ITask
TimeSpan	Frequency [get]

Detailed Description

Recurring task. Returns true once done

Constructor & Destructor Documentation

RecurringTask() [1/2]

pluginbase.Objects.Tasks.RecurringTask.RecurringTask	(	Func< TaskResult >	method,
		TimeSpan	frequency
	)

        {
            _method = method;
            Frequency = frequency;
        }

RecurringTask() [2/2]

pluginbase.Objects.Tasks.RecurringTask.RecurringTask	(	Action	task,
		TimeSpan	frequency
	)

        {
            Frequency = frequency;
            _method = () => {
                task();
                return TaskResult.Continue;
            };
        }

Member Function Documentation

InvokeTask()

TaskResult pluginbase.Objects.Tasks.RecurringTask.InvokeTask

(

long

maxMilliseconds

)

Implements pluginbase.Objects.Tasks.ITask.

        {
            return _method();
        }

ToString()

override string pluginbase.Objects.Tasks.RecurringTask.ToString

(

)

        {
            return string.Format("[RecurringTask: Frequency={0}, {1}]", Frequency, _method.Method.Name);
        }

Property Documentation

Frequency

TimeSpan pluginbase.Objects.Tasks.RecurringTask.Frequency

get

---

The documentation for this class was generated from the following file:

• pluginbase/Objects/Tasks/RecurringTask.cs