pluginbase.Objects.Tasks.SchedulerExtensions Class Reference

Adds various helper extension methods to the scheduler More...

Static Public Member Functions
static IScheduledTask	ScheduleRecurringTask (this ITaskScheduler scheduler, Func< TaskResult > method, TimeSpan frequency)
	Schedules a task that will repeat until it returns a stop result More...
static IScheduledTask	ScheduleInfiniteTask (this ITaskScheduler scheduler, Action method, TimeSpan frequency)
	Schedules a task that will be run until the termination of the context More...
static IScheduledTask	ScheduleTask (this ITaskScheduler scheduler, Action method, TimeSpan inTime)
	Schedule a task to happen one time in the future More...
static IScheduledTask	ScheduleTask (this ITaskScheduler scheduler, Action method, DateTime forTimeUtc)
	Schedule a task to happen one time in the future More...
static IScheduledTask	IterateSystem (this ITaskScheduler scheduler, Func< int, TaskResult > method)
	Schedules an iterable system It will increment the first parameter, running multiple times in a frame until 'Remove' is returned More...
static IScheduledTask	IterateSystem (this ITaskScheduler scheduler, IIterableSystem system)
	Iterate a system. See IIterableSystem More...
static IScheduledTask	ScheduleYieldingTask (this ITaskScheduler scheduler, Func< IEnumerable< ITaskYieldAction >> method)
	Schedule a yielding task. This task can yield specific classes to control the flow of the task See: YieldNext, YieldReset, YieldWait, YieldTask More...
static IScheduledTask	ScheduleWeakTask (this ITaskScheduler scheduler, Func< TaskResult > method, TimeSpan frequency)
	Schedules a weak-bound task. Great if you're not sure you can dispose of it properly. Must be a class-method, can not be lambda or closure More...
static IScheduledTask	ScheduleInfiniteWeakTask (this ITaskScheduler scheduler, Action method, TimeSpan frequency)
	Schedule a recurring task that's called for as long as an object exists More...
static IScheduledTask	Enumerate< T > (this ITaskScheduler scheduler, IEnumerable< T > e, Func< T, TaskResult > eval, TimeSpan freq)
	Enumerate through each item in the IEnumerable and runs an evaluator against them More...
static IScheduledTask	Enumerate< T > (this ITaskScheduler scheduler, IEnumerable< T > e, Func< T, TaskResult > eval)
	Enumerate through each item in the IEnumerable and runs an evaluator against them More...
static IScheduledTask	Enumerate< T > (this ITaskScheduler scheduler, IEnumerable< T > e, Action< T > eval, TimeSpan freq)
	Enumerate through each item in the IEnumerable and runs an evaluator against them More...
static IScheduledTask	Enumerate< T > (this ITaskScheduler scheduler, IEnumerable< T > e, Action< T > eval)
	Enumerate through each item in the IEnumerable and runs an evaluator against them More...

Detailed Description

Adds various helper extension methods to the scheduler

Member Function Documentation

Enumerate< T >() [1/4]

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.Enumerate< T > ( this ITaskScheduler  scheduler, IEnumerable< T >  e, Func< T, TaskResult >  eval, TimeSpan  freq  )

static

Enumerate through each item in the IEnumerable and runs an evaluator against them

Returns

The enumerate.

Parameters

scheduler	Scheduler.
e	E.
eval	Eval.
freq	Freq.

Template Parameters

T	The 1st type parameter.

        {
            return scheduler.ScheduleTask(new EnumerableTask<T>(e, eval, freq));
        }

Enumerate< T >() [2/4]

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.Enumerate< T > ( this ITaskScheduler  scheduler, IEnumerable< T >  e, Func< T, TaskResult >  eval  )

static

Enumerate through each item in the IEnumerable and runs an evaluator against them

Returns

The enumerate.

Parameters

scheduler	Scheduler.
e	E.
eval	Eval.

Template Parameters

T	The 1st type parameter.

        {
            return Enumerate<T>(scheduler, e, eval, TimeSpan.FromMilliseconds(1));
        }

Enumerate< T >() [3/4]

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.Enumerate< T > ( this ITaskScheduler  scheduler, IEnumerable< T >  e, Action< T >  eval, TimeSpan  freq  )

static

Enumerate through each item in the IEnumerable and runs an evaluator against them

Returns

The enumerate.

Parameters

scheduler	Scheduler.
e	E.
eval	Eval.
freq	Freq.

Template Parameters

T	The 1st type parameter.

        {
            return scheduler.ScheduleTask(new EnumerableTask<T>(e, eval, freq));
        }

Enumerate< T >() [4/4]

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.Enumerate< T > ( this ITaskScheduler  scheduler, IEnumerable< T >  e, Action< T >  eval  )

static

Enumerate through each item in the IEnumerable and runs an evaluator against them

Returns

The enumerate.

Parameters

scheduler	Scheduler.
e	E.
eval	Eval.

Template Parameters

T	The 1st type parameter.

        {
            return Enumerate<T>(scheduler, e, eval, TimeSpan.FromMilliseconds(1));
        }

IterateSystem() [1/2]

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.IterateSystem ( this ITaskScheduler  scheduler, Func< int, TaskResult >  method  )

static

Schedules an iterable system It will increment the first parameter, running multiple times in a frame until 'Remove' is returned

Returns

THe task instance

Parameters

scheduler	Scheduler.
method	Method to be run.

        {
            var task = new IterativeTask(method);
            return scheduler.ScheduleTask(task);
        }

IterateSystem() [2/2]

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.IterateSystem ( this ITaskScheduler  scheduler, IIterableSystem  system  )

static

Iterate a system. See IIterableSystem

Returns

The task instance.

Parameters

scheduler	Scheduler.
system	System instance to be iterated

        {
            var task = new IterativeTask(system);
            return scheduler.ScheduleTask(task);
        }

ScheduleInfiniteTask()

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.ScheduleInfiniteTask ( this ITaskScheduler  scheduler, Action  method, TimeSpan  frequency  )

static

Schedules a task that will be run until the termination of the context

Returns

The task instance.

Parameters

scheduler	Scheduler.
method	Method to be run
frequency	Frequency at which method will be invoked

        {
            var task = new RecurringTask(method, frequency);
            return scheduler.ScheduleTask(task);
        }

ScheduleInfiniteWeakTask()

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.ScheduleInfiniteWeakTask ( this ITaskScheduler  scheduler, Action  method, TimeSpan  frequency  )

static

Schedule a recurring task that's called for as long as an object exists

Returns

The weak task.

Parameters

scheduler	Scheduler.
method	Method.
frequency	Frequency.

        {
            var task = new WeakTask(method, frequency);
            return scheduler.ScheduleTask(task);
        }

ScheduleRecurringTask()

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.ScheduleRecurringTask ( this ITaskScheduler  scheduler, Func< TaskResult >  method, TimeSpan  frequency  )

static

Schedules a task that will repeat until it returns a stop result

Returns

The task instance.

Parameters

scheduler	Scheduler.
method	Method to be run
frequency	Frequency at which method will be invoked

        {
            var task = new RecurringTask(method, frequency);
            return scheduler.ScheduleTask(task);
        }

ScheduleTask() [1/2]

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.ScheduleTask ( this ITaskScheduler  scheduler, Action  method, TimeSpan  inTime  )

static

Schedule a task to happen one time in the future

Returns

The task instance.

Parameters

scheduler	Scheduler.
method	Method to invoke
inTime	Time in the future to run it

        {
            var task = new SingleTask(method, inTime);
            return scheduler.ScheduleTask(task);
        }

ScheduleTask() [2/2]

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.ScheduleTask ( this ITaskScheduler  scheduler, Action  method, DateTime  forTimeUtc  )

static

Schedule a task to happen one time in the future

Returns

The task instance.

Parameters

scheduler	Scheduler.
method	Method to invoke.
forTimeUtc	The time at which to invoke at

        {
            var task = new SingleTask(method, forTimeUtc - DateTime.UtcNow );
            return scheduler.ScheduleTask(task);
        }

ScheduleWeakTask()

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.ScheduleWeakTask ( this ITaskScheduler  scheduler, Func< TaskResult >  method, TimeSpan  frequency  )

static

Schedules a weak-bound task. Great if you're not sure you can dispose of it properly. Must be a class-method, can not be lambda or closure

Returns

The task instance.

Parameters

scheduler	Scheduler.
method	Method to invoke
frequency	Frequency to invoke at

        {
            var task = new WeakTask(method, frequency);
            return scheduler.ScheduleTask(task);
        }

ScheduleYieldingTask()

static IScheduledTask pluginbase.Objects.Tasks.SchedulerExtensions.ScheduleYieldingTask ( this ITaskScheduler  scheduler, Func< IEnumerable< ITaskYieldAction >>  method  )

static

Schedule a yielding task. This task can yield specific classes to control the flow of the task See: YieldNext, YieldReset, YieldWait, YieldTask

Returns

The task isntance.

Parameters

scheduler	Scheduler.
method	Method to invoke.

        {
            var task = new YieldingTask(method);
            return scheduler.ScheduleTask(task);
        }

---

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

• pluginbase/Objects/Tasks/SchedulerExtensions.cs