ActivityLang Class Reference

#include "vault/gear/activity-lang.hpp"

Description

Term builder and execution framework to perform chains of scheduler Activities.

These are the verbs of a low-level execution language for render jobs; individual Activity records are managed by the BlockFlow allocation scheme and maintained until expiration of their deadline. To enact a render job, a connection of Activities will be suitably wired, and the entry point to start execution can be instructed into the Scheduler.

The ActivityLang object provides an construction and execution service

• it provides a builder API to construct terms of properly wired Activity records
• the activity::Term serves as a transient object for wiring and configuration and can be discarded after enqueuing the entry point of a chain.
• the static function ActivityLang::dispatchChain() provides the execution logic for activating a chain of Activities successively.
• for real usage, this execution environment needs some functionality implemented in the scheduler, which — for the purpose of Activity activation — is abstracted as an Execution Context with the following operations ** λ-post : hand over a chain of Activities for (time bound) activation ** λ-work : signal start of media processing and then leave »management mode« ** λ-done : signal completion of media processing ** λ-tick : activate an internal heartbeat and scheduler maintenance hook

See also

Activity

SchedulerActivity_test

Definition at line 69 of file activity-lang.hpp.

Static Public Member Functions
template<class EXE >
static activity::Proc	dispatchChain (Activity *chain, EXE &executionCtx)
	Execution Framework: dispatch performance of a chain of Activities.
template<class EXE >
static activity::Proc	activateChain (Activity *chain, EXE &executionCtx)
	Execution Framework: successive activation of Activities in a chain.

Public Member Functions
	ActivityLang (BlockFlowAlloc &memManager)
activity::Term	buildCalculationJob (Job job, Time start, Time deadline)
	Builder-API: initiate definition of render activities for a media calculation job.
activity::Term	buildAsyncLoadJob (Job job, Time start, Time deadline)
	Builder-API: initiate definition of IO data loading activities.
activity::Term	buildMetaJob (Job job, Time start, Time deadline)
	Builder-API: initiate definition of internal/planning job.
Activity &	createTick (Time deadline)
void	discardBefore (Time deadline)
void	announceLoad (FrameRate fps)

Private Member Functions
activity::Term	setupActivityScheme (activity::Term::Template schemeKind, Job job, Time start, Time dead)

Private Attributes
BlockFlowAlloc &	mem_

Constructor & Destructor Documentation

ActivityLang()

ActivityLang ( BlockFlowAlloc &  memManager )

inlineexplicit

Definition at line 75 of file activity-lang.hpp.

Member Function Documentation

buildCalculationJob()

activity::Term buildCalculationJob ( Job  job, Time  start, Time  deadline  )

inline

Builder-API: initiate definition of render activities for a media calculation job.

Definition at line 86 of file activity-lang.hpp.

References Term::CALC_JOB, and ActivityLang::setupActivityScheme().

Referenced by ScheduleSpec::maybeBuildTerm().

Here is the call graph for this function:

Here is the caller graph for this function:

buildAsyncLoadJob()

activity::Term buildAsyncLoadJob ( Job  job, Time  start, Time  deadline  )

inline

Builder-API: initiate definition of IO data loading activities.

Definition at line 95 of file activity-lang.hpp.

References Term::LOAD_JOB, and ActivityLang::setupActivityScheme().

Here is the call graph for this function:

buildMetaJob()

activity::Term buildMetaJob ( Job  job, Time  start, Time  deadline  )

inline

Builder-API: initiate definition of internal/planning job.

Definition at line 104 of file activity-lang.hpp.

References Term::META_JOB, and ActivityLang::setupActivityScheme().

Referenced by Scheduler::continueMetaJob().

Here is the call graph for this function:

Here is the caller graph for this function:

createTick()

Activity & createTick ( Time  deadline )

inline

setup a scheduler »Tick« for internal state maintenance

Definition at line 111 of file activity-lang.hpp.

References ActivityLang::mem_, Activity::TICK, and BlockFlow< CONF >::until().

Referenced by Scheduler::handleDutyCycle().

Here is the call graph for this function:

Here is the caller graph for this function:

discardBefore()

void discardBefore ( Time  deadline )

inline

propagate new clean-up deadline to the BlockFlow allocator

Definition at line 114 of file activity-lang.hpp.

References BlockFlow< CONF >::discardBefore(), and ActivityLang::mem_.

Referenced by Scheduler::handleDutyCycle().

Here is the call graph for this function:

Here is the caller graph for this function:

announceLoad()

void announceLoad ( FrameRate  fps )

inline

announce expected additional load to the allocator

Definition at line 117 of file activity-lang.hpp.

References BlockFlow< CONF >::announceAdditionalFlow(), and ActivityLang::mem_.

Referenced by Scheduler::seedCalcStream().

Here is the call graph for this function:

Here is the caller graph for this function:

dispatchChain()

template<class EXE >

static activity::Proc dispatchChain ( Activity *  chain, EXE &  executionCtx  )

inlinestatic

Execution Framework: dispatch performance of a chain of Activities.

Definition at line 125 of file activity-lang.hpp.

References ActivityLang::activateChain(), Activity::dispatch(), Activity::next, vault::gear::activity::PASS, and vault::gear::activity::SKIP.

Referenced by SchedulerCommutator_test::demonstrateSimpleUsage(), SchedulerActivity_test::dispatchChain(), Scheduler::doWork(), SchedulerCommutator_test::integratedWorkCycle(), SchedulerActivity_test::scenario_IOJob(), SchedulerActivity_test::scenario_MetaJob(), SchedulerActivity_test::scenario_Notification(), SchedulerActivity_test::scenario_RenderJob(), and SchedulerCommutator_test::verify_dispatch().

Here is the call graph for this function:

Here is the caller graph for this function:

activateChain()

template<class EXE >

static activity::Proc activateChain ( Activity *  chain, EXE &  executionCtx  )

inlinestatic

Execution Framework: successive activation of Activities in a chain.

Definition at line 141 of file activity-lang.hpp.

References Activity::activate(), Activity::next, vault::gear::activity::PASS, and vault::gear::activity::SKIP.

Referenced by ActivityLang::dispatchChain().

Here is the call graph for this function:

Here is the caller graph for this function:

setupActivityScheme()

activity::Term setupActivityScheme ( activity::Term::Template  schemeKind, Job  job, Time  start, Time  dead  )

inlineprivate

generate the builder / configurator term

Definition at line 157 of file activity-lang.hpp.

References ActivityLang::mem_, and BlockFlow< CONF >::until().

Referenced by ActivityLang::buildAsyncLoadJob(), ActivityLang::buildCalculationJob(), and ActivityLang::buildMetaJob().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mem_

BlockFlowAlloc& mem_

private

Definition at line 71 of file activity-lang.hpp.

Referenced by ActivityLang::announceLoad(), ActivityLang::createTick(), ActivityLang::discardBefore(), and ActivityLang::setupActivityScheme().

Collaboration diagram for ActivityLang:

---

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

• activity-lang.hpp