pluginbase.Objects.Tasks.ChainedTaskExtensions Class Reference

Static Public Member Functions
static ChainedTask	Then (this ITask task, ITask nextTask)
	Chain a task to run after a given task More...
static ChainedTask	Then (this ITask task, Action method)
	Execute an action More...
static ChainedTask	Then (this ITask task, Action method, TimeSpan delay)
	Execute an action after a delay More...
static ChainedTask	Then (this ITask task, Action method, int repeat, TimeSpan delay)
	Execute an action n times, with a delay More...
static ChainedTask	Then (this ITask task, Func< TaskResult > method, TimeSpan frequency)
	Execute an action with a frequency until done More...
static ChainedTask	Then (this ITask task, Func< IEnumerable< ITaskYieldAction >> yieldingTask)
	Execute a chained task More...
static ChainedTask	Wait (this ITask task, TimeSpan timespan)
	Wait a timespan More...
static ChainedTask	Wait (this ITask task, double seconds)
	Wait a timespan More...
static ChainedTask	Wait (this ITask task, Func< bool > until)
	Wait until a delegate return true More...
static ChainedTask	Wait (this ITask task, TimeSpan timespan, Action< double > tick, TimeSpan tickSpeed)
	Wait for a duration of time, and execute a tick after every increment More...
static ChainedTask	Wait (this ITask task, TimeSpan timespan, Action< double > tick)
	Wait for a duration of time, and execute a tick after every 0.25 second increment More...
static ChainedTask	Finally (this ITask task, Action< Exception > fin)
	Promise the specified task will always run after the task completes or fails More...
static ChainedTask	Finally (this ITask task)
	Promises the task will finish running and now explode More...

Member Function Documentation

Finally() [1/2]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Finally ( this ITask  task, Action< Exception >  fin  )

static

Promise the specified task will always run after the task completes or fails

Parameters

task	Task.
fin	Promise.

        {
            return ChainedTask.Chain(task).Finally(fin);
        }

Finally() [2/2]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Finally ( this ITask  task )

static

Promises the task will finish running and now explode

Parameters

task

Task.

        {
            return ChainedTask.Chain(task).Finally(x => {});
        }

Then() [1/6]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Then ( this ITask  task, ITask  nextTask  )

static

Chain a task to run after a given task

Parameters

task	Task.
nextTask	Next task.

        {
            return ChainedTask.Chain(task, nextTask);
        }

Then() [2/6]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Then ( this ITask  task, Action  method  )

static

Execute an action

Parameters

task	Task.
method	Method.

        {
            return ChainedTask.Chain(task, new SingleTask(method, TimeSpan.Zero));
        }

Then() [3/6]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Then ( this ITask  task, Action  method, TimeSpan  delay  )

static

Execute an action after a delay

Parameters

task	Task.
method	Method.
delay	Delay.

        {
            return ChainedTask.Chain(task, new SingleTask(method, delay));
        }

Then() [4/6]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Then ( this ITask  task, Action  method, int  repeat, TimeSpan  delay  )

static

Execute an action n times, with a delay

Parameters

task	Task.
method	Method.
repeat	Repeat.
delay	Delay.

        {
            return ChainedTask.Chain(task, new RepeatingTask(method, repeat, delay));
        }

Then() [5/6]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Then ( this ITask  task, Func< TaskResult >  method, TimeSpan  frequency  )

static

Execute an action with a frequency until done

Parameters

task	Task.
method	Method.
frequency	Frequency.

        {
            return ChainedTask.Chain(task, new RecurringTask(method, frequency));
        }

Then() [6/6]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Then ( this ITask  task, Func< IEnumerable< ITaskYieldAction >>  yieldingTask  )

static

Execute a chained task

Parameters

task	Task.
yieldingTask	Yielding task.

        {
            return ChainedTask.Chain(task, new YieldingTask(yieldingTask));
        }

Wait() [1/5]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Wait ( this ITask  task, TimeSpan  timespan  )

static

Wait a timespan

Parameters

task	Task.
timespan	Timespan.

        {
            return ChainedTask.Chain(task, new SingleTask(() => {}, timespan));
        }

Wait() [2/5]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Wait ( this ITask  task, double  seconds  )

static

Wait a timespan

Parameters

task	Task.
seconds	Seconds.

        {
            return ChainedTask.Chain(task, new SingleTask(() => {}, TimeSpan.FromSeconds(seconds)));
        }

Wait() [3/5]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Wait ( this ITask  task, Func< bool >  until  )

static

Wait until a delegate return true

Parameters

task	Task.
until	Until.

        {
            return ChainedTask.Chain(task, new RecurringTask( () => until() ? TaskResult.Remove : TaskResult.Continue, TimeSpan.FromSeconds(0.1) ));
        }

Wait() [4/5]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Wait ( this ITask  task, TimeSpan  timespan, Action< double >  tick, TimeSpan  tickSpeed  )

static

Wait for a duration of time, and execute a tick after every increment

Parameters

task	Task.
timespan	Timespan.
tick	Tick.
tickSpeed	Tick speed.

        {
            int repeatCount = (int)Math.Ceiling(timespan.TotalSeconds / tickSpeed.TotalSeconds);
            int i = 0;
            return Then(task,
                        () => {
                            i++;
                            tick(tickSpeed.TotalSeconds * i);
                        },
                        repeatCount,
                        tickSpeed);
        }

Wait() [5/5]

static ChainedTask pluginbase.Objects.Tasks.ChainedTaskExtensions.Wait ( this ITask  task, TimeSpan  timespan, Action< double >  tick  )

static

Wait for a duration of time, and execute a tick after every 0.25 second increment

Parameters

task	Task.
timespan	Timespan.
tick	Tick.

        {
            return Wait(task, timespan, tick, TimeSpan.FromSeconds(0.25));
        }

---

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

• pluginbase/Objects/Tasks/ChainedTaskExtensions.cs