vault::gear Namespace Reference

Description

Active working gear and plumbing.

Notably the Scheduler and performance observation and self-regulation are implemented here.

Namespaces
namespace	activity
namespace	anonymous_namespace{engine-config.cpp}
namespace	anonymous_namespace{job.cpp}
namespace	anonymous_namespace{load-controller.hpp}
namespace	anonymous_namespace{scheduler-commutator.hpp}
namespace	anonymous_namespace{scheduler-invocation.hpp}
namespace	anonymous_namespace{scheduler.hpp}
namespace	anonymous_namespace{work-force.cpp}
namespace	anonymous_namespace{work-force.hpp}
namespace	blockFlow
namespace	test
namespace	work

Typedefs
using	BlockFlowAlloc = BlockFlow< blockFlow::RenderConfig >
typedef lumiera_jobParameter const &	JobParameter

Classes
struct	ActivationEvent
class	Activity
	Record to describe an Activity, to happen within the Scheduler's control flow. More...
class	ActivityLang
	Term builder and execution framework to perform chains of scheduler Activities. More...
class	BlockFlow
	Allocation scheme for the Scheduler, based on Epoch(s). More...
class	EngineConfig
	Point of access for any kind of engine configuration, setup and performance tweaks. More...
class	EngineEvent
	Low-level Render Engine event — abstracted storage base. More...
class	EngineObserver
	Collector and aggregator for performance data. More...
class	FlowDiagnostic
class	Job
	Individual frame rendering task, forwarding to a closure. More...
class	JobClosure
	Interface of the closure for frame rendering jobs. More...
class	JobFunctor
class	LoadController
	Controller to coordinate resource usage related to the Scheduler. More...
class	ManifestationID
	Marker for current (and obsolete) manifestations of a CalcStream processed by the Render-Engine. More...
class	NopJobFunctor
	Stub/Test implementation of the JobFunctor interface for a render job to do nothing at all More...
class	Scheduler
	»Scheduler-Service« : coordinate render activities. More...
class	SchedulerCommutator
	Scheduler Layer-2 : execution of Scheduler Activities. More...
class	SchedulerDiagnostics
	Render engine diagnostic facility. More...
class	SchedulerFrontend
	Access point to the scheduler service provided by the back-end. More...
class	SchedulerInvocation
	Scheduler Layer-1 : time based dispatch. More...
class	ScheduleSpec
class	SpecialFunPrototype
	Interface: JobFunctor configured to invoke a function a limited number of times. More...
class	SpecialJobFun
	Front-end to configure a special job functor for one-time use. More...
class	WorkForce
	Pool of worker threads for rendering. More...
class	WorkTiming
	work-timing event for performance observation More...

Functions
HashVal	hash_value (ManifestationID const &id)
template<class CONF >
FlowDiagnostic< CONF >	watch (BlockFlow< CONF > &theFlow)
HashVal	hash_value (Job const &job)
	hash value based on all relevant job data.
bool	operator== (Job const &left, Job const &right)
bool	operator!= (Job const &left, Job const &right)

Typedef Documentation

BlockFlowAlloc

typedef BlockFlow< blockFlow::RenderConfig > BlockFlowAlloc

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

JobParameter

typedef lumiera_jobParameter const& JobParameter

Definition at line 205 of file job.h.

Function Documentation

hash_value() [1/2]

HashVal hash_value

(

ManifestationID const &

id

)

Definition at line 45 of file activity-lang.cpp.

Referenced by SchedulerDiagnostics::is_scheduled_background(), SchedulerDiagnostics::is_scheduled_freewheeling(), SchedulerDiagnostics::is_scheduled_timebound(), operator!=(), operator==(), and LoadController::scatteredDelayTime().

Here is the caller graph for this function:

watch()

template<class CONF >

FlowDiagnostic< CONF > watch ( BlockFlow< CONF > &  theFlow )

inline

Definition at line 774 of file block-flow.hpp.

Referenced by FlowDiagnostic< CONF >::cntEpochs(), SchedulerStress_test::investigateWorkProcessing(), SchedulerService_test::invokeWorkFunction(), BlockFlow_test::placeActivity(), FlowDiagnostic< CONF >::poolSize(), SchedulerService_test::processSchedule(), SchedulerService_test::scheduleRenderJob(), SchedulerStress_test::setup_systematicSchedule(), BlockFlow_test::simpleUsage(), SchedulerService_test::simpleUsage(), SchedulerStress_test::smokeTest(), BlockFlow_test::storageFlow(), SchedulerActivity_test::termBuilder(), TestChainLoad_test::usageExample(), SchedulerStress_test::verify_instrumentation(), SchedulerService_test::verify_LoadFactor(), and SchedulerService_test::verify_StartStop().

Here is the caller graph for this function:

hash_value() [2/2]

HashVal hash_value

(

Job const &

job

)

hash value based on all relevant job data.

provide a hash based Job ID

Job records hashing to the same value shall be considered equivalent. Since the interpretation of the InvocationInstanceID is a private detail of the JobClosure, calculating this hash requires a virtual call into the concrete JobClosure. This is not considered problematic, as the normal job operation and scheduling doesn't rely on the job's hash. Only some diagnostic facilities do.

Definition at line 104 of file job.cpp.

operator==()

bool operator== ( Job const &  left, Job const &  right  )

inline

Definition at line 316 of file job.h.

References hash_value().

Here is the call graph for this function:

operator!=()

bool operator!= ( Job const &  left, Job const &  right  )

inline

Definition at line 322 of file job.h.

References hash_value().

Here is the call graph for this function: