pluginbase.Objects.Tasks.TaskEx Class Reference

Static Public Member Functions
static async Task	SpinWait (Func< bool > until, int pollMillis=10, int timeoutMillis=-1)
	Wait for a predicate to become true via polling More...
static TaskAwaiter< bool >	GetAwaiter (this IScheduledTask task)
	GetAwaiter on a scheduled task (allows you to await the task) More...
static Task< T >	QueueAsyncTask< T > (this ITaskScheduler scheduler, Func< T > func)
	Queues an async task on the scheduler to result in an awaitable task Only use if you know what you're doing. Much of empeld is not async-safe More...
static Task	QueueAsyncTask (this ITaskScheduler scheduler, Action func)
	Queues an async task on the scheduler to be an awaitable task Only use if you know what you're doing. Much of empeld is not async-safe More...

Member Function Documentation

GetAwaiter()

static TaskAwaiter<bool> pluginbase.Objects.Tasks.TaskEx.GetAwaiter ( this IScheduledTask  task )

static

GetAwaiter on a scheduled task (allows you to await the task)

Returns

The awaiter.

Parameters

task

Task.

        {
            var tcs = new TaskCompletionSource<bool>();

            if (task.IsDone)
            {
                tcs.SetResult(true);
            }
            else
            {
                task.Finish += (t) => tcs.SetResult(true);
            }

            return tcs.Task.GetAwaiter();
        }

QueueAsyncTask()

static Task pluginbase.Objects.Tasks.TaskEx.QueueAsyncTask ( this ITaskScheduler  scheduler, Action  func  )

static

Queues an async task on the scheduler to be an awaitable task Only use if you know what you're doing. Much of empeld is not async-safe

Returns

The async task.

Parameters

scheduler	Scheduler.
func	Func.

        {
            return QueueAsyncTask<bool>(scheduler, () => {
                func();
                return true;
            });
        }

QueueAsyncTask< T >()

static Task<T> pluginbase.Objects.Tasks.TaskEx.QueueAsyncTask< T > ( this ITaskScheduler  scheduler, Func< T >  func  )

static

Queues an async task on the scheduler to result in an awaitable task Only use if you know what you're doing. Much of empeld is not async-safe

Returns

The async task.

Parameters

scheduler	Scheduler.
func	Func.

Template Parameters

T	The 1st type parameter.

        {
            var tcs = new TaskCompletionSource<T>();

            scheduler.QueueAsync(() => {
                try
                {
                    tcs.SetResult(func());
                }
                catch(Exception e)
                {
                    tcs.SetException(e);
                }
            });

            return tcs.Task;
        }

SpinWait()

static async Task pluginbase.Objects.Tasks.TaskEx.SpinWait ( Func< bool >  until, int  pollMillis = 10, int  timeoutMillis = -1  )

static

Wait for a predicate to become true via polling

Returns

The wait.

Parameters

until	Until.
pollMillis	Poll millis.
timeoutMillis	Timeout millis.

        {
            int totalWait = 0;
            while(!until() && (timeoutMillis < 0 || totalWait < timeoutMillis))
            {
                await Task.Delay(pollMillis);
                totalWait += pollMillis; // Not exact, but close enough (better than timing)
            }
        }

---

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

• pluginbase/Objects/Tasks/TaskEx.cs