BaseProcessorDispatcher.h

// BaseProcessorDispatcher.h:
// --------------------------
//

#ifndef __IPSDKBASEPROCESSING_BASEPROCESSORDISPATCHER_H__
#define __IPSDKBASEPROCESSING_BASEPROCESSORDISPATCHER_H__

// suppression warnings
// warning C4251: 'ipsdk::processor::BaseProcessorDispatcher::_processorRulePolicy' : class 'ipsdk::processor::eProcessorRulePolicy' needs to have dll-interface to be used by clients of class 'ipsdk::processor::BaseProcessorDispatcher'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKBaseProcessing/IPSDKBaseProcessingExports.h>
#include <IPSDKBaseProcessing/Processor/ProcessorTypes.h>
#include <IPSDKBaseProcessing/ProcessorDispatcher/ElementsInfo/ElementsInfoTypes.h>
#include <IPSDKCore/Processing/ActionProvider/BaseActionProvider.h>
#include <IPSDKUtil/Tools/ProcessingResult.h>
#include <IPSDKUtil/Tools/NumericLimits.h>
#include <boost/thread/mutex.hpp>

namespace ipsdk {
namespace processor {


class IPSDKBASEPROCESSING_API BaseProcessorDispatcher : public core::BaseActionProvider
{
public:
    BaseProcessorDispatcher();
    virtual ~BaseProcessorDispatcher() = 0;
    
// methods
public:
    void                            setProcessorRulePolicy(const eProcessorRulePolicy& processorRulePolicy);
    const eProcessorRulePolicy&     getProcessorRulePolicy() const;

    BoolResult                      setProcessorDispatchPolicy(const ProcessorDispatchPolicy& processorDispatchPolicy);

    const ProcessorDispatchPolicy&  getProcessorDispatchPolicy() const;

    virtual const std::string&      getProcessorName() const = 0;

    virtual const std::string&      getProcessorToolTip() const = 0;

    ElementsSplitInfoConstPtr       getElementsSplitInfo() const;

    ipUInt64                        getNbNotReleased() const;

    ipUInt64                        getNbPendingElements() const;

    ipUInt64                        getNbProcessedElements() const;

    RemoteDataSize                  getNotReleasedDataSizes() const;

    ipUInt64                        getRemainingDataMemorySize() const;

protected:
    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);

    virtual ProcessorPtr        createProcessor() const = 0;

    virtual BoolResult          initAttributes(const ElementsRange& elementsRange,
                                               const core::BaseRequestOrigin& requestOrigin,
                                               const ProcessorPtr& pProcessor) = 0;

    void                        broadcastToRemotes();

private:
    core::QueryResult       queryNextAction(const core::BaseRequestOrigin& requestOrigin,
                                            core::ActionRequestPtr& pActionRequest,
                                            bool& bProcessCompletionCheck,
                                            SerializationObjectPtr& pCbAdditionalData);

    core::QueryResult       acquireNextProcessingRange(const core::BaseRequestOrigin& requestOrigin,
                                                       ElementsRange& elementsRange,
                                                       ipUInt64& dataMemorySize);

    BoolResult              createProcessor(const ElementsRange& elementsRange,
                                            const core::BaseRequestOrigin& requestOrigin,
                                            ProcessorPtr& pProcessor);

    bool                    hasPendingAction() const;

    BoolResult              notifyDerived(const core::ActionRequestPtr& pActionRequest,
                                          const SerializationObjectConstPtr& pCbAdditionalData,
                                          bool& bRestartProvider);

// attributes
private:
    eProcessorRulePolicy        _processorRulePolicy;

    ElementsLocationInfoPtr     _pElementsLocationInfo;

    ElementsSplitInfoPtr        _pElementsSplitInfo;

    // flag indicating whether local processing is allowed for dispatcher
    bool                        _bLocalProcessingAllowed;

    // flag indicating whether remote processing is allowed for dispatcher
    bool                        _bRemoteProcessingAllowed;

    GuidSet                     _broadcastSocketGuids;

    GuidSet                     _overSuppliedSocketGuids;

    ProcessorDispatchPolicyPtr  _pProcessorDispatchPolicy;
};


} // end of namespace processor
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKBASEPROCESSING_BASEPROCESSORDISPATCHER_H__