RemoteActionRequest.h

// RemoteActionRequest.h:
// ----------------------
//

#ifndef __IPSDKCORE_REMOTEACTIONREQUEST_H__
#define __IPSDKCORE_REMOTEACTIONREQUEST_H__

// suppression warnings
// warning C4251: 'ipsdk::core::RemoteActionRequest::_bPreviousRes' : class 'ipsdk::ProcessingResult<T>' needs to have dll-interface to be used by clients of class 'ipsdk::core::RemoteActionRequest'
#pragma warning (push)
#pragma warning (disable : 4251)

#include <IPSDKCore/Processing/ActionRequest/BaseActionRequest.h>
#include <IPSDKCore/Processing/Action/ActionTypes.h>
#include <IPSDKUtil/BaseTypes.h>
#include <IPSDKUtil/Tools/Guid.h>
#include <IPSDKComm/TcpIp/Types.h>
#include <boost/thread/mutex.hpp>
#include <boost/thread/condition_variable.hpp>

namespace ipsdk {
namespace core {


class IPSDKCORE_API RemoteActionRequest : public BaseActionRequest
{
    // friend class for protected accesses
    friend class UpdateRemoteAction;

public:
    RemoteActionRequest();
    ~RemoteActionRequest();
    
// methods
public:
    eActionRequestType      getActionRequestType() const;

    BoolResult              init(const Guid& socketGuid,
                                 const Guid& providerGuid);

    const Guid&             getSocketGuid() const;

    const Guid&             getProviderGuid() const;

    bool                    isNoMoreActionDetected() const;

protected:
    ExecResult              executeActionDerived();

    void                    updateAction(const ActionPtr& pAction);

    void                    updateActionFailure(const std::string& msg);

    void                    updateActionNoMore();

    void                    requestCancellationDerived();

    void                    clearDerived();

    void                    notifyActionCompletion(const ActionPtr& pAction);

    void                    deliveryCB(const Guid& socketGuid,
                                       ipUInt64 nDeliveryId,
                                       bool bSuccess);

    void                    connectionLostCB(const tcpip::SocketDesc& socketDesc,
                                             const boost::system::error_code& ec);

// attributes
protected:
    Guid                        _socketGuid;

    Guid                        _providerGuid;

    Guid                        _socketCBGuid;

    ActionPtr                   _pAction;

    boost::mutex                _derivedMutex;

    boost::condition_variable   _derivedCondition;

    bool                        _bNoMoreActionDetected;
};


inline eActionRequestType
RemoteActionRequest::getActionRequestType() const
{
    return eActionRequestType::eART_Remote;
}


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

#pragma warning (pop)

#endif // __IPSDKCORE_REMOTEACTIONREQUEST_H__