SchedulableLink Class Reference

#include <SchedulableLink.h>

Inheritance diagram for SchedulableLink:

Collaboration diagram for SchedulableLink:

Public Member Functions
void	NextScene (Scene s)
virtual Scene	ProcessScene (Scene s)=0
void	Start ()
void	Stop ()
bool	Available ()
Public Member Functions inherited from PipelineLink
void	RegisterCallback (SceneCallback *scb)
virtual void	NextScene (Scene next)=0

Protected Member Functions
void	Enqueue (Scene s)
void	Run ()
void	NextScene (Scene scene)

Protected Attributes
BlockingQueue< Scene >	scheduleQueue
bool	isOn = true
std::thread	scheduleWorker
Protected Attributes inherited from PipelineLink
SceneCallback *	sceneCallback = nullptr

Detailed Description

A class which extends PipelineLink to handle latency-bound stages. The NextScene function is inherited to add Scenes to an internal BlockingQueue. The pure virtual function ProcessScene must be implemented by derived classes to define Scene processing behaviour. The Run method is called in a separate thread and handles waking up the thread when scenes are available and calling back to the next pipeline element. BlockingQueue is used as a scheduling mechanism for future extension to multithreading.

Definition at line 17 of file SchedulableLink.h.

Member Function Documentation

Available()

bool SchedulableLink::Available

(

)

Returns

true if the scheduleQueue is empty; false otherwise.

Definition at line 27 of file SchedulableLink.cpp.

                                {
    return scheduleQueue.IsEmpty(); //singly threaded for now
}

Enqueue()

void SchedulableLink::Enqueue ( Scene  s )

protected

Adds a scene to the intenal scheduleQueue

Parameters

s

Definition at line 21 of file SchedulableLink.cpp.

                                     {
    scheduleQueue.Push(s);
}

NextScene()

void SchedulableLink::NextScene ( Scene  scene )

virtual

If space is available on the scheduleQueue, add the scene to the queue. Otherwise skip.

Parameters

scene

Reimplemented from PipelineLink.

Definition at line 48 of file SchedulableLink.cpp.

                                           {
    //if space on schedule queue, add this scene; otherwise pass the scene through
    if(scheduleQueue.IsEmpty()) { //singly threaded for now
        scheduleQueue.Push(scene);
    }
}

ProcessScene()

virtual Scene SchedulableLink::ProcessScene ( Scene  s )

pure virtual

Implemented in CNNProcessor.

Run()

void SchedulableLink::Run ( )

protected

Looping process to process scenes and call-back to next pipeline element. Worker thread is slept while no elements are available using BlockingQueue functionality

Definition at line 8 of file SchedulableLink.cpp.

                         {
    //waits for scenes to appear on the scheduleQueue,
    while(isOn){
        Scene s = scheduleQueue.Pop(); //Blocking Queue Sleeps Execution Until Scene arrives
        Scene out = ProcessScene(s);
        if(!sceneCallback) continue;
        sceneCallback->NextScene(out);
    }
}

Start()

void SchedulableLink::Start

(

)

Starts execution with the worker thread.

Definition at line 34 of file SchedulableLink.cpp.

                            {
    scheduleWorker = std::thread(&SchedulableLink::Run, this);
}

Stop()

void SchedulableLink::Stop

(

)

Turns off the link, kills worker thread. Must be called to release thread resources.

Definition at line 40 of file SchedulableLink.cpp.

                          {
    isOn = false;
    scheduleWorker.join();
}

Member Data Documentation

isOn

bool SchedulableLink::isOn = true

protected

Definition at line 28 of file SchedulableLink.h.

scheduleQueue

BlockingQueue<Scene> SchedulableLink::scheduleQueue

protected

Definition at line 27 of file SchedulableLink.h.

scheduleWorker

std::thread SchedulableLink::scheduleWorker

protected

Definition at line 29 of file SchedulableLink.h.

---

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

• src/SchedulableLink.h
• src/SchedulableLink.cpp