BaseActionRequest.h

// BaseActionRequest.h:
// --------------------
//

#ifndef __IPSDKCORE_BASEACTIONREQUEST_H__
#define __IPSDKCORE_BASEACTIONREQUEST_H__

// suppression warnings
// warning C4275: non dll-interface class 'boost::noncopyable_::noncopyable' used as base for dll-interface class 'ipsdk::core::BaseActionRequest'
// warning C4251: 'ipsdk::core::BaseActionRequest::_requestCompletionCB' : class 'boost::function1<R,T0>' needs to have dll-interface to be used by clients of class 'ipsdk::core::BaseActionRequest'
#pragma warning (push)
#pragma warning (disable : 4275 4251)

#include <IPSDKCore/IPSDKCoreExports.h>
#include <IPSDKCore/Processing/ProcessingTypes.h>
#include <IPSDKCore/Processing/ActionRequest/ActionRequestTypes.h>
#include <IPSDKUtil/Tools/ProcessingResult.h>
#include <IPSDKUtil/Tools/Guid.h>
#include <boost/enable_shared_from_this.hpp>
#include <boost/noncopyable.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition_variable.hpp>

namespace ipsdk {
namespace core {


class IPSDKCORE_API BaseActionRequest : public boost::noncopyable,
                                        public boost::enable_shared_from_this<BaseActionRequest>
{
    // friend class for protected accesses
    friend class AskForRemoteAction;
    friend class BaseActionProvider;

public:
    BaseActionRequest();
    virtual ~BaseActionRequest() = 0;
    
// methods
public:
    virtual eActionRequestType  getActionRequestType() const = 0;

    bool                        isInit() const;

    const Guid&                 getGuid() const;

    eExecutionStatus            getStatus() const;

    void                        addCompletionCB(const RequestCompletionCB& completionCB);

    ExecResult                  executeAction();

    void                        requestCancellation();

    bool                        isCancellationRequested() const;

    void                        waitForCompletion();

    ExecResult                  getActionResult() const;

    void                        clear();

protected:
    BoolResult                  initBase(const Guid& requestGuid = Guid());

    virtual ExecResult          executeActionDerived() = 0;

    virtual void                requestCancellationDerived() = 0;

    virtual void                clearDerived() {}

    void                        setStatusToWaiting();

    void                        notifyCompletion(const ExecResult& bResult);

private:
    void                        internalClear();

    void                        addCompletionCB(const RequestCompletionCB& completionCB,
                                                bool bPushBack);

// attributes
private:
    Guid                        _requestGuid;

    eExecutionStatus            _requestStatus;

    ExecResult                  _bActionResult;

    RequestCompletionCBColl     _completionCBColl;

    bool volatile               _bCancellationRequested;

    mutable boost::mutex        _mutex;

    boost::condition_variable   _condition;

    bool                        _bInit;
};


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


} // end of namespace core
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKCORE_BASEACTIONREQUEST_H__