The Nebula Device 3: Jobs::SerialJobPort Class Reference

The Nebula Device 3

Jobs::SerialJobPort Class Reference

#include <serialjobport.h>

Inheritance diagram for Jobs::SerialJobPort:

Base::JobPortBase Core::RefCounted

Detailed Description

JobPort implementation in the serial job system. In the serial job system, PushJob() will immediately execute the job and return after the job has executed. All other methods are empty and return immediately.

(C) 2009 Radon Labs GmbH

Public Member Functions

 SerialJobPort ()
 constructor
virtual ~SerialJobPort ()
 destructor
void PushJob (const Ptr< Jobs::Job > &job)
 push a job for execution
void PushJobChain (const Util::Array< Ptr< Jobs::Job > > &jobs)
 push a job chain, each job in the chain depends on previous job
void PushFlush ()
 push a flush command (makes sure that jobs don't re-use uniform data from previous jobs)
void PushSync ()
 push a sync command (waits for completion of all previous jobs on this port)
void WaitDone ()
 wait for completion
bool CheckDone ()
 check for completion, return immediately
void Setup ()
 setup the job port
void Discard ()
 discard the job port
bool IsValid () const
 return true if the job object is valid
int GetRefCount () const
 get the current refcount
void AddRef ()
 increment refcount by one
void Release ()
 decrement refcount and destroy object if refcount is zero
bool IsInstanceOf (const Rtti &rtti) const
 return true if this object is instance of given class
bool IsInstanceOf (const Util::String &className) const
 return true if this object is instance of given class by string
bool IsInstanceOf (const Util::FourCC &classFourCC) const
 return true if this object is instance of given class by fourcc
bool IsA (const Rtti &rtti) const
 return true if this object is instance of given class, or a derived class
bool IsA (const Util::String &rttiName) const
 return true if this object is instance of given class, or a derived class, by string
bool IsA (const Util::FourCC &rttiFourCC) const
 return true if this object is instance of given class, or a derived class, by fourcc
const Util::StringGetClassName () const
 get the class name
Util::FourCC GetClassFourCC () const
 get the class FourCC code

Static Public Member Functions

static void DumpRefCountingLeaks ()
 dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

Member Function Documentation

void Jobs::SerialJobPort::PushJob ( const Ptr< Jobs::Job > &  job  ) 

push a job for execution

This executes the job immediately in the current thread and returns afterwards.

Reimplemented from Base::JobPortBase.

void Jobs::SerialJobPort::PushJobChain ( const Util::Array< Ptr< Jobs::Job > > &  jobs  ) 

push a job chain, each job in the chain depends on previous job

Push a job chain, where each job in the chain depends on the previous job. This will also guarantee, that the first job slice of each job will run on the same worker thread. In case of simple jobs (with only one slice) this improves load.

Reimplemented from Base::JobPortBase.

int Core::RefCounted::GetRefCount (  )  const [inline, inherited]

get the current refcount

Return the current refcount of the object.

void Core::RefCounted::AddRef (  )  [inline, inherited]

increment refcount by one

Increment the refcount of the object.

void Core::RefCounted::Release (  )  [inline, inherited]

decrement refcount and destroy object if refcount is zero

Decrement the refcount and destroy object if refcount is zero.

const Util::String & Core::RefCounted::GetClassName (  )  const [inline, inherited]

get the class name

Get the class name of the object.

Util::FourCC Core::RefCounted::GetClassFourCC (  )  const [inline, inherited]

get the class FourCC code

Get the class FourCC of the object.

void Core::RefCounted::DumpRefCountingLeaks (  )  [static, inherited]

dump refcounting leaks, call at end of application (NEBULA3_DEBUG builds only!)

This method should be called as the very last before an application exits.