PendingActionRequest.h

// PendingActionRequest.h:
// -----------------------
//

#ifndef __IPSDKCORE_PENDINGACTIONREQUEST_H__
#define __IPSDKCORE_PENDINGACTIONREQUEST_H__

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

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

namespace ipsdk {

class BaseIArchive;

namespace core {


class IPSDKCORE_API PendingActionRequest : public BaseActionRequest
{
    // friend class for protected accesses
    friend class UpdatePendingAction;
    friend class AskForRemoteAction;

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

    BoolResult              init(const ActionPtr& pAction,
                                 const Guid& socketGuid,
                                 const Guid& providerGuid,
                                 const Guid& requestGuid);

    const Guid&             getSocketGuid() const;

    const Guid&             getProviderGuid() const;

protected:
    BoolResult              sendAction();

    ExecResult              executeActionDerived();

    void                    updateAction(BaseIArchive& ar);

    BoolResult              notifyActionUpdated();

    void                    requestCancellationDerived();

    void                    clearDerived();

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

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

// attributes
protected:
    ActionPtr                       _pAction;

    Guid                            _socketGuid;

    Guid                            _providerGuid;

    Guid                            _socketCBGuid;

    boost::mutex                    _derivedMutex;
};


inline eActionRequestType
PendingActionRequest::getActionRequestType() const
{
    return eActionRequestType::eART_Pending;
}


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

#pragma warning (pop)

#endif // __IPSDKCORE_PENDINGACTIONREQUEST_H__