ProcessorDispatchPolicy.h

// ProcessorDispatchPolicy.h:
// --------------------------
//

#ifndef __IPSDKBASEPROCESSING_PROCESSORDISPATCHPOLICY_H__
#define __IPSDKBASEPROCESSING_PROCESSORDISPATCHPOLICY_H__

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

#include <IPSDKBaseProcessing/IPSDKBaseProcessingExports.h>
#include <IPSDKBaseProcessing/Processor/Policy/ProcessorDispatchPolicyTypes.h>
#include <IPSDKSerialization/Engine/BaseSerializationObject.h>

namespace ipsdk {
namespace processor {


class IPSDKBASEPROCESSING_API ProcessorDispatchPolicy : public BaseSerializationObject
{
    // declare serial class
    IPSDK_DECLARE_SERIAL_WITH_COPY(IPSDKBaseProcessing, ProcessorDispatchPolicy);

public:
    ProcessorDispatchPolicy();
    ~ProcessorDispatchPolicy();
    
// methods
public:
    bool                            isInit() const;

    void                            initDefault();

    void                            initLocal();

    void                            initLocalAndRemote(const ipUInt32 nbMaxThread);

    void                            initMonoThread();

    void                            initLocal(const ipUInt32 nbMaxThread);

    void                            initRemote(const ipUInt32 nbMaxThread);

    void                            init(const eDispatchLocationType& dispatchLocationType,
                                         const ipUInt32 nbMaxThread);

    ipUInt32                        getNbMaxThread() const;

    const eDispatchLocationType&    getDispatchLocationType() const;

    bool                            isLocalProcessingAllowed() const;

    bool                            isRemoteProcessingAllowed() const;

    void                            retrictPolicy(const ProcessorDispatchPolicy& policy);

    void                            clear();

// attributes
protected:
    ipUInt32                _nbMaxThread;

    eDispatchLocationType   _dispatchLocationType;

    bool                    _bInit;
};


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


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

#pragma warning (pop)

#endif // __IPSDKBASEPROCESSING_PROCESSORDISPATCHPOLICY_H__