Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://www.ncbi.nlm.nih.gov/IEB/ToolBox/CPP_DOC/doxyhtml/app__job__dispatcher_8cpp_source.html below:

NCBI C++ ToolKit: src/gui/utils/app_job_dispatcher.cpp Source File

report_period,

auto_delete)

: m_Job(&job), m_ID(id), m_State(

),

m_Engine(engine), m_Listener(listener),

m_ReportPeriod(report_period),

m_AutoDelete(auto_delete)

*kMessage =

;

(e.GetErrCode()) {

}

(std::exception& ee) {

(

<< name <<

);

it->second->RequestCancel();

IEngineParams* params)

auto_delete, IEngineParams* params)

(job, engine_name, translator, report_period,

auto_delete, params);

auto_delete, IEngineParams* params)

(job, engine_name, &listener, report_period,

auto_delete, params);

*

=

;

*

=

;

auto_delete, IEngineParams* params)

listener, report_period, auto_delete);

}

(std::exception& e) {

(job, *engine, listener, report_period, auto_delete);

report_period,

)

(report_period > 0) {

time_t

= time(

) + report_period;

;

;

;

;

(

<< job_id);

;

;

;

;

;

;

;

(e.GetErrCode()) {

}

(std::exception& ee) {

rec->

->GetProgress();

(

<< engine_name <<

);

it->second.GetPointer();

;

(

);

(

= 0;

; ++

) {

& job = *

.m_Job;

;

;

s =

+ rec.

->GetDescr();

s +=

;

s +=

;

descr = rec.

->GetDescr();

(

<<

<< descr <<

);

kPeriod = 15;

done_something =

;

time_t now = time(

);

(now >= check_time) {

done_something =

;

done_something;

(rec->

!= new_state) {

time_t new_time = now + kPeriod;

done_something;

listener.

(evt);

listener.

(evt);

(

<< jobId);

listener.

(evt);

listener.

(evt);

static const char * kCancelErrNotReg

static const char * kJobRegistered

static const char * kResumeErrNotRunning

static const char * kSuspendErrNotReg

#define DISP_CATCH_AND_REPORT(message, job)

static const char * kResumeErrEngine

static const char * kDeleteErrEngine

static const char * kSuspendErrEngine

static const char * kSuspendErrNotRunning

static const char * kCannotStart

static const char * kResumeErrNotReg

static const char * kUnknownEngine

static const char * kCancelErrEngine

static const char * kCancelErrNotRunning

DEFINE_CLASS_STATIC_MUTEX(CAppJobDispatcher::sm_Mutex)

CAppJobDispatcher.

static const char * kListenerException

#define DISP_CATCH_AND_THROW(message, job)

static const char * kDefaultErrorMessage

CAppJobError Default implementation for IAppJobError - encapsulates a text error message.

CAppJobEventTranslator Standard Listener that generates notification events.

IAppJobListener Interface for components that need to be notified about changes in Jobs.

CAppJobNotification Notification send by CAppJobEventTranslator.

void Release()

Manually force the resource to be released.

bvector< Alloc > & set(size_type n, bool val=true)

Sets bit n if val is true, clears bit n if val is false.

container_type::const_iterator const_iterator

container_type::iterator iterator

const_iterator end() const

const_iterator find(const key_type &key) const

iterator insert(const value_type &val)

const_iterator begin() const

container_type::value_type value_type

#define NON_CONST_ITERATE(Type, Var, Cont)

Non constant version of ITERATE macro.

#define ERR_POST(message)

Error posting with file, line number information but without error codes.

#define LOG_POST(message)

This macro is deprecated and it's strongly recomended to move in all projects (except tests) to macro...

void Error(CExceptionArgs_Base &args)

#define NCBI_THROW(exception_class, err_code, message)

Generic macro to throw an exception, given the exception class, error code and message string.

#define NCBI_CATCH(message)

Catch CExceptions as well This macro is deprecated - use *_X or *_XX variant instead of it.

virtual const char * what(void) const noexcept

Standard report (includes full backlog).

#define NCBI_RETHROW(prev_exception, exception_class, err_code, message)

Generic macro to re-throw an exception.

virtual void StartJob(IAppJob &job, IEngineParams *params=NULL)=0

If Engine cannot start the Job and exception shall be thrown.

TJobID x_StartJob(IAppJob &job, const string &engine_name, CAppJobEventTranslator *listener, int report_period, bool auto_delete, IEngineParams *params)

void x_OnJobStateChangedNotify(SJobRecord &rec)

virtual void ResumeJob(IAppJob &job)=0

SJobRecord * x_GetJobRecord(TJobID job_id)

virtual ~CAppJobDispatcher()

bool x_IsCanceled(int job_id) const

virtual void SuspendJob(IAppJob &job)=0

IAppJobEngine * x_GetRegisteredEngine(const string &engine_name)

Helper functions these functions rely on external synchronization and do not throw / catch exception.

void RunSync(IAppJob &job, TJobID &jobId, CEventHandler &listener)

Runs jon synchronously sending job notifications synchronously Returns when job is finished.

TTimeToItem m_PollQueue

Job Index (by pointer)

void ShutDown()

Terminates all jobs and releases Engines.

static bool IsTerminal(TJobState state)

virtual void SetListener(IAppJobEngineListener *listener)=0

For "active" mode set a Listener that will be notified when the state of a Job changes.

void x_FlushStateEventQueue()

CAppJobDispatcher()

Release the singleton.

static CRef< CAppJobDispatcher > sm_Dispatcher

global dispatcher, this instance is used by default in most cases, however it is possible to create a...

static CAppJobDispatcher & GetInstance()

void Mute(bool bMute=true)

Mute all notifications.

void x_VerifyProgressNotNull(CAppJobDispatcher::SJobRecord &rec)

SJobRecord(IAppJob &job, TJobID id, TJobState state, IAppJobEngine &engine, CAppJobEventTranslator *listener, int report_period, bool auto_delete)

CAppJobDispatcher::SJobRecord.

virtual CConstIRef< IAppJobError > GetError()=0

Returns IAppJobError object describing internal error that caused the Job to fail.

bool IdleCallback()

this function shall be called in the the application idle function.

void SetDispatcher(CAppJobDispatcher &disp)

static void ReleaseInstance()

get the Singleton Dispatcher

virtual void CancelJob(IAppJob &job)=0

Cancel job in the engine If job is not running yet - just remove from the pending queue otherwise use...

static string StateToStr(TJobState state)

TStateEventQueue m_StateEventQueue

priority queue for Dispatcher to poll on

friend class CAppJobEventTranslator

virtual CRef< CObject > GetResult()=0

Returns the Job Result.

static string GetStatusString(TJobState job_state)

Debugging method for status strings.

bool m_AutoDelete

delete the record when job finishes

int m_ReportPeriod

if > 0, active progress reporting is required

CConstIRef< IAppJobError > GetJobError(TJobID job_id)

void ResumeJob(TJobID job_id)

CFastMutex m_EngineMutex

Engines registry mutex.

CIRef< CAppJobEventTranslator > m_Listener

if not null - "active" mode

void x_OnJobStarted(IAppJob &job, IAppJobEngine &, CAppJobEventTranslator *listener, int report_period, bool)

handles state transition

bool DeleteJob(TJobID job_id)

when a Job is deleted the listener is not notified

EJobState

Job states (describe FSM)

bool m_ShutDownInProgress

Shutdown flag.

virtual void OnEngineJobStateChanged(IAppJob &job, TJobState new_state)

IAppJobEngineListener.

TPtrToRec m_PtrToRec

Job Registry (index by JobID)

TJobID StartJob(IAppJob &job, const string &engine_name, IEngineParams *params=NULL)

Starts a Job on the specified engine in "passive mode" - no notifications or progress reports will be...

virtual string GetDescr() const =0

Returns a human readable description of the Job (optional)

virtual bool IsActive()=0

Returns true if Engine supports "active" model i.e.

virtual EJobState Run()=0

Function that does all the useful work, called by the Engine.

void x_AddJobRecord(SJobRecord &rec)

CRef< CObject > GetJobResult(TJobID job_id)

bool ActiveProgress() const

CConstIRef< IAppJobProgress > GetJobProgress(TJobID job_id)

TNameToEngine m_NameToEngine

Engines Registry.

TJobState GetJobState(TJobID job_id)

All Get() functions return values stored in the Registy not the actual.

virtual TJobState GetJobState(IAppJob &job) const =0

void CancelAllJobs()

Request to cancel all jobs (func returns without waiting)

void CancelJob(TJobID job_id)

bool RegisterEngine(const string &name, IAppJobEngine &engine)

Registers a new Engine, returns true if successful.

CConstIRef< IAppJobProgress > m_Progress

static void x_OnJobStateChanged(SJobRecord &rec, TJobState new_state)

Update job record, throws an exception if new state change is incorrect.

virtual bool Send(CEvent *evt, EDispatch disp_how=eDispatch_Default, int pool_name=ePool_Default)

Sends an event synchronously.

void SuspendJob(TJobID job_id)

CMutex m_MainMutex

guards this instance of the Dispatcher

void x_RemoveJobRecord(SJobRecord &rec)

void x_OnJobProgressNotify(SJobRecord &rec)

CFastMutex m_StateEventMutex

virtual void ShutDown()=0

stop any background threads and free resources associated with the Engine

bm::bvector m_CancelVect

Canceled jobs vector.

@ eEngine_UnknownJob

the job is not registered in the Engine

@ eEngineBusy

Engine is busy, caller needs to re-try the operation.

@ eEngine_InvalidOperation

Engine - operation is invalid.

TObjectType * GetPointer(void) const THROWS_NONE

Get pointer,.

TObjectType * GetPointer(void) THROWS_NONE

Get pointer,.

void Reset(void)

Reset reference object.

void Reset(void)

Reset reference object.

TObjectType & GetObject(void)

Get object.

#define END_NCBI_SCOPE

End previously defined NCBI scope.

#define BEGIN_NCBI_SCOPE

Define ncbi namespace.

void Lock(void)

Lock mutex.

bool TryLock(void)

Try locking mutex.

void Unlock(void)

Unlock mutex.

@ BM_GAP

GAP compression is ON.

void SleepMilliSec(unsigned long ml_sec, EInterruptOnSignal onsignal=eRestartOnSignal)

Multi-threading – mutexes; rw-locks; semaphore.

SJobRecord describes a Job registered in Dispatcher.

SQueueItem - element of the Polling Queue.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4