56 lines
2.5 KiB
C++
56 lines
2.5 KiB
C++
/***
|
|
Copyright (C) 2021 J Reece Wilson (a/k/a "Reece"). All rights reserved.
|
|
|
|
File: IWorkItem.hpp
|
|
Date: 2021-11-1
|
|
Author: Reece
|
|
***/
|
|
#pragma once
|
|
|
|
namespace Aurora::Async
|
|
{
|
|
struct IWorkItem
|
|
{
|
|
virtual AuSPtr<IWorkItem> WaitFor(const AuSPtr<IWorkItem> &pWorkItem) = 0;
|
|
virtual AuSPtr<IWorkItem> WaitFor(const AuList<AuSPtr<IWorkItem>> &workItems) = 0;
|
|
|
|
// do not schedule a loop-source more than once
|
|
// you may ILoopSource::WaitOn arbitrarily; however, you must not attach it to the threads loopqueue more than once.
|
|
virtual AuSPtr<IWorkItem> SetSchedByLoopSource(const AuSPtr<IO::Loop::ILoopSource> &pLoopSource) = 0;
|
|
|
|
// ms = time relative to the current time in milliseconds
|
|
virtual AuSPtr<IWorkItem> SetSchedTime(AuUInt32 ms) = 0;
|
|
|
|
// ns = time relative to the current time in nanoseconds
|
|
virtual AuSPtr<IWorkItem> SetSchedTimeNs(AuUInt64 ns) = 0;
|
|
|
|
// ms = wall time (AuTime::CurrentClockMS()) in milliseconds
|
|
virtual AuSPtr<IWorkItem> SetSchedTimeAbs(AuUInt32 ms) = 0;
|
|
|
|
// ns = wall time (AuTime::CurrentClockNS()) in nanoseconds
|
|
virtual AuSPtr<IWorkItem> SetSchedTimeNsAbs(AuUInt64 ns) = 0;
|
|
|
|
// ns = steady time (AuTime::SteadyClockNS()) in nanoseconds
|
|
virtual AuSPtr<IWorkItem> SetSchedSteadyTimeNsAbs(AuUInt64 ns) = 0;
|
|
|
|
// ms = time relative to the time at which the work item would otherwise dispatch
|
|
virtual AuSPtr<IWorkItem> AddDelayTime(AuUInt32 ms) = 0;
|
|
|
|
// ns = time relative to the time at which the work item would otherwise dispatch
|
|
virtual AuSPtr<IWorkItem> AddDelayTimeNs(AuUInt64 ns) = 0;
|
|
|
|
// inverted WaitFor
|
|
virtual AuSPtr<IWorkItem> Then(const AuSPtr<IWorkItem> &next) = 0;
|
|
|
|
virtual AuSPtr<IWorkItem> Dispatch() = 0;
|
|
|
|
virtual void SetPrio(EWorkPriority prio) = 0;
|
|
|
|
virtual bool BlockUntilComplete() = 0;
|
|
virtual bool HasFinished() = 0;
|
|
virtual bool HasFailed() = 0;
|
|
virtual void Cancel() = 0;
|
|
|
|
virtual void *GetPrivateData() = 0;
|
|
};
|
|
} |