Base class for processor operations dispatching. More...

#include <BaseProcessorDispatcher.h>

Inheritance diagram for ipsdk::processor::BaseProcessorDispatcher:

Public Member Functions
BoolResult	setProcessorDispatchPolicy (const ProcessorDispatchPolicy &processorDispatchPolicy)
	select used processor dispatch policy More...

const ProcessorDispatchPolicy &	getProcessorDispatchPolicy () const
	retrieve used processor dispatch policy More...

virtual const std::string &	getProcessorName () const =0
	retrieve processor name associated to dispatch operation

virtual const std::string &	getProcessorToolTip () const =0
	retrieve processor tooltip associated to dispatch operation

ElementsSplitInfoConstPtr	getElementsSplitInfo () const
	retrieve informations about splitted data More...

ipUInt64	getNbNotReleased () const
	retrieve the number of non released (i.e. running) processors

ipUInt64	getNbPendingElements () const
	retrieve the number of pending (i.e. waiting to start) processors

ipUInt64	getNbProcessedElements () const
	retrieve the number of finished processors

RemoteDataSize	getNotReleasedDataSizes () const
	retrieve the size of data used by the process

ipUInt64	getRemainingDataMemorySize () const
	retrieve the size of remaining data

Constructors and destructors
	BaseProcessorDispatcher ()

virtual	~BaseProcessorDispatcher ()=0


void	setProcessorRulePolicy (const eProcessorRulePolicy &processorRulePolicy)
	access to used rule policy on created processors

const eProcessorRulePolicy &	getProcessorRulePolicy () const
	access to used rule policy on created processors

Public Member Functions inherited from ipsdk::core::BaseActionProvider
bool	isInit () const
	retrieve object initialization flag

const Guid &	getGuid () const
	retrieve guid associated to provider More...

const ePriority &	getActionsPriority () const
	retrieve priority associated to provided actions More...

eExecutionStatus	getStatus () const
	check for provider execution status More...

void	addCompletionCB (const ProviderCompletionCB &completionCB)
	add a completion callback associated to action provider More...

bool	areActionsPending () const
	check whether additional actions potentially are pending More...

void	waitForCompletion ()
	method allowing to wait for execution completion More...

bool	waitForCompletion (const boost::chrono::milliseconds &duration)
	method allowing to wait for a given duration for execution completion More...

bool	waitForCompletion (const boost::chrono::system_clock::time_point &deadLineTime)
	method allowing to wait until a given time point for execution completion More...

void	requestCancellation ()
	method allowing to request cancellation More...

bool	isCancellationRequested () const
	check whether a cancellation has been requested More...

ExecResult	getGlobalResult () const
	retrieve execution global result More...

double	getFullExecutionDuration () const
	retrieve full execution time More...

void	clear ()
	clear of object data More...

	BaseActionProvider ()

virtual	~BaseActionProvider ()=0

Protected Member Functions
BoolResult	initBase (const core::BasePriority &actionPriority, const ElementsLocationInfo &elementsLocationInfo, const GuidSet &broadcastSocketGuids, const ipUInt64 nbMinEltsPerSplit, const ipUInt64 nbMaxEltsPerSplit, const ipUInt64 minMemSzPerThread=0, const ipUInt64 maxMemSzPerThread=NumericLimits< ipUInt64 >::max(), const ipUInt64 nbMaxThreads=0)
	base class initialization method It is possible to enforce the maximum number of threads used to dispatch the data More...

virtual ProcessorPtr	createProcessor () const =0
	create a new instance of associated processor

virtual BoolResult	initAttributes (const ElementsRange &elementsRange, const core::BaseRequestOrigin &requestOrigin, const ProcessorPtr &pProcessor)=0
	initialize a processor attributes in derived class given an elements range to process

void	broadcastToRemotes ()
	method allowing to broadcast processor dispatcher to all configured remote processing servers

Protected Member Functions inherited from ipsdk::core::BaseActionProvider
BoolResult	initBase (const BasePriority &actionsPriority, const Guid &providerGuid=Guid())
	base class initialization method More...

bool	existsRemoteProvider (const Guid &socketGuid)
	check whether a remote provider exists for a given socket guid More...

void	addRemoteProvider (const Guid &socketGuid)
	define a new remote provider for a given socket guid More...

bool	unRegisterRemoteProvider (const Guid &socketGuid)
	un register a remote provider for a given socket guid More...

BoolResult	registerRemoteProvider (const Guid &socketGuid)
	instantly register a new remote provider for a given socket guid More...

BoolResult	registerRemoteProviders ()
	register remote providers associated to object More...

virtual void	clearDerived ()
	clear of data in derived class

virtual void	requestCancellationDerived ()
	method allowing to request cancellation in derived classes

Detailed Description

Base class for processor operations dispatching.

Author: E. Noirfalise

Date: 2013/9/25

Copyright: 2013 Reactiv'IP, all right reserved.

Note: call setProcessorDispatchPolicy before use

Member Function Documentation

◆ setProcessorDispatchPolicy()

BoolResult ipsdk::processor::BaseProcessorDispatcher::setProcessorDispatchPolicy ( const ProcessorDispatchPolicy & processorDispatchPolicy )

select used processor dispatch policy

Returns: false in case of failure (licence mismatch with processor dispatch location policy)

Exceptions

ipsdk::core::IPSDKCoreException if isInit() == false

◆ getProcessorDispatchPolicy()

const ProcessorDispatchPolicy& ipsdk::processor::BaseProcessorDispatcher::getProcessorDispatchPolicy ( ) const

retrieve used processor dispatch policy

Exceptions

ipsdk::core::IPSDKCoreException if isInit() == false

◆ getElementsSplitInfo()

ElementsSplitInfoConstPtr ipsdk::processor::BaseProcessorDispatcher::getElementsSplitInfo ( ) const

retrieve informations about splitted data

Exceptions

ipsdk::core::IPSDKCoreException if getStatus() != eExecutionStatus::eES_Completed

◆ initBase()

BoolResult ipsdk::processor::BaseProcessorDispatcher::initBase	(	const core::BasePriority &	actionPriority,
		const ElementsLocationInfo &	elementsLocationInfo,
		const GuidSet &	broadcastSocketGuids,
		const ipUInt64	nbMinEltsPerSplit,
		const ipUInt64	nbMaxEltsPerSplit,
		const ipUInt64	minMemSzPerThread = `0`,
		const ipUInt64	maxMemSzPerThread = `NumericLimits< ipUInt64 >::max()`,
		const ipUInt64	nbMaxThreads = `0`
	)

protected

base class initialization method It is possible to enforce the maximum number of threads used to dispatch the data

Note: if nbMaxThreads == 0, the number of threads is determined by the local processing policy

Exceptions

ipsdk::core::IPSDKCoreException	if nbMinEltsPerSplit == 0
ipsdk::core::IPSDKCoreException	if nbMinEltsPerSplit > nbMaxEltsPerSplit

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKBaseProcessing/ProcessorDispatcher/BaseProcessorDispatcher.h

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ setProcessorDispatchPolicy()

◆ getProcessorDispatchPolicy()

◆ getElementsSplitInfo()

◆ initBase()