Class TaskBase

Namespace

Ceres.Tasks

Assembly

Ceres.dll

Base class for framework task

public abstract class TaskBase : CallbackEventHandler, IEventHandler, IDisposable

Inheritance

object

CallbackEventHandler

TaskBase

Implements

IEventHandler

IDisposable

Derived

PooledTaskBase<T>

Inherited Members

CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)

CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)

CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)

CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)

CallbackEventHandler.HandleEventAtTargetPhase(EventBase)

CallbackEventHandler.HandleEventAtTargetAndDefaultPhase(EventBase)

CallbackEventHandler.HandleEventAtCurrentTargetAndPhase(EventBase)

CallbackEventHandler.HasTrickleDownHandlers()

CallbackEventHandler.HasBubbleUpHandlers()

CallbackEventHandler.ExecuteDefaultActionAtTarget(EventBase)

CallbackEventHandler.ExecuteDefaultAction(EventBase)

CallbackEventHandler.ExecuteDefaultActionDisabledAtTarget(EventBase)

CallbackEventHandler.ExecuteDefaultActionDisabled(EventBase)

CallbackEventHandler.IsCompositeRoot

CallbackEventHandler.Parent

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ObservableExtensions.AsObservable<TEventType>(CallbackEventHandler)

ObservableExtensions.AsObservable<TEventType>(CallbackEventHandler, TrickleDown)

TaskExtensions.Run(TaskBase)

TaskExtensions.Run<TTask>(TTask)

DisposableExtensions.AddTo<T>(T, IDisposableUnregister)

Constructors

TaskBase()

protected TaskBase()

Fields

Status

protected TaskStatus Status

Field Value

TaskStatus

Properties

Coordinator

public override IEventCoordinator Coordinator { get; }

Property Value

IEventCoordinator

Methods

Acquire()

public virtual void Acquire()

CompleteTask()

protected void CompleteTask()

Dispose()

public virtual void Dispose()

GetCompleteEvent()

Get task complete event

public TaskCompleteEvent GetCompleteEvent()

Returns

TaskCompleteEvent

GetStatus()

public virtual TaskStatus GetStatus()

Returns

TaskStatus

GetTaskID()

public abstract string GetTaskID()

Returns

string

GetTaskName()

Debug usage

protected virtual string GetTaskName()

Returns

string

Init()

protected virtual void Init()

Pause()

public virtual void Pause()

RegisterPrerequisite(TaskBase)

Add a prerequisite task before this task run

public void RegisterPrerequisite(TaskBase taskBase)

Parameters

taskBase TaskBase

Reset()

protected virtual void Reset()

SendEvent(EventBase, DispatchMode)

Sends an event to the event handler.

public override void SendEvent(EventBase e, DispatchMode dispatchMode = DispatchMode.Default)

Parameters

e EventBase

The event to send.

dispatchMode DispatchMode

The event dispatch mode.

Start()

public virtual void Start()

Stop()

public virtual void Stop()

Tick()

public virtual void Tick()

UnregisterPrerequisite(TaskBase)

Remove a prerequisite task if exist

public bool UnregisterPrerequisite(TaskBase taskBase)

Parameters

taskBase TaskBase

Returns

bool