ElementsSplitInfo.h

// ElementsSplitInfo.h:
// --------------------
//

#ifndef __IPSDKBASEPROCESSING_ELEMENTSSPLITINFO_H__
#define __IPSDKBASEPROCESSING_ELEMENTSSPLITINFO_H__

// suppression warnings
// warning C4275: non dll-interface class 'boost::noncopyable_::noncopyable' used as base for dll-interface class 'ipsdk::processor::ElementsSplitInfo'
// warning C4251: 'ipsdk::processor::ElementsSplitInfo::_pendingElements' : class 'std::map<_Kty,_Ty>' needs to have dll-interface to be used by clients 
#pragma warning (push)
#pragma warning (disable : 4275 4251)

#include <IPSDKBaseProcessing/IPSDKBaseProcessingExports.h>
#include <IPSDKBaseProcessing/ProcessorDispatcher/ElementsInfo/ElementsInfoTypes.h>
#include <IPSDKCore/Processing/ActionProvider/ActionProviderTypes.h>
#include <boost/noncopyable.hpp>

namespace ipsdk {
namespace processor {


class IPSDKBASEPROCESSING_API ElementsSplitInfo : public boost::noncopyable
{
public:
    ElementsSplitInfo();
    ~ElementsSplitInfo();

// methods
public:
    bool                    isInit() const;

    void                    init(const ElementsLocationInfo& elementsLocationInfo,
                                 const ipUInt64 nbMinEltsPerSplit,
                                 const ipUInt64 nbMaxEltsPerSplit,
                                 const ipUInt64 minMemSzPerSplit,
                                 const ipUInt64 maxMemSzPerSplit,
                                 const ipUInt64 nbMaxAskedThreads);

    ipUInt64                getNbMinEltsPerSplit() const;

    ipUInt64                getNbMaxEltsPerSplit() const;

    ipUInt64                getMinMemSzPerSplit() const;

    ipUInt64                getMaxMemSzPerSplit() const;

    bool                    hasPendingData() const;

    bool                    hasRemainingData() const;

    bool                    hasSocketGuid(const Guid& socketGuid) const;

    ipUInt64                getRemainingDataMemorySize() const;

    ipUInt64                getRemainingDataMemorySize(const Guid& socketGuid) const;

    ipUInt64                getAcquiredDataMemorySize(const Guid& socketGuid) const;

    core::QueryResult       acquiredNextRange(ElementsRange& acquiredElementsRange,
                                              ipUInt64& acquiredDataMemorySize);

    core::QueryResult       acquiredNextRange(const Guid& socketGuid,
                                              ElementsRange& acquiredElementsRange,
                                              ipUInt64& acquiredDataMemorySize);

    core::QueryResult       stealNextLocalRange(const Guid& socketGuid,
                                                ElementsRange& acquiredElementsRange,
                                                ipUInt64& acquiredDataMemorySize);

    core::QueryResult       forceNextRangeAcquisition(ElementsRange& acquiredElementsRange,
                                                      ipUInt64& acquiredDataMemorySize);

    void                    markHasReleased(const Guid& socketGuid,
                                            const ElementsRange& elementsRange);

    const ElementsLocation& getProcessedElements() const;

    ipUInt64                getNbProcessedElements() const;

    ipUInt64                getNbNotReleased() const;

    ipUInt64                getNbPendingElements() const;

    RemoteDataSize          getNotReleasedDataSizes() const;

    void                    clear();

protected:
    core::QueryResult       acquiredNextRange(const Guid& socketGuidOwner,
                                              const Guid& socketGuidProcessor,
                                              ElementsRange& acquiredElementsRange,
                                              ipUInt64& acquiredDataMemorySize);


// attributes
protected:
    ipUInt64                    _nbMinEltsPerSplit;

    ipUInt64                    _nbMaxEltsPerSplit;

    ipUInt64                    _minMemSzPerSplit;

    ipUInt64                    _maxMemSzPerSplit;

    ipUInt64                    _remainingDataMemorySize;

    ElementsLocation            _pendingElements;

    ElementsLocation            _acquiredElements;

    RemoteDataSize              _acquiredDataSizes;

    ElementsLocation            _processedElements;

    bool                        _bInit;
};


inline bool
ElementsSplitInfo::isInit() const
{
    return _bInit;
}


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

#pragma warning (pop)

#endif // __IPSDKBASEPROCESSING_ELEMENTSSPLITINFO_H__