cXProtocolClient.h

Go to the documentation of this file.

//
//
#ifndef _INC_cXProtocolClient_H
#define _INC_cXProtocolClient_H
#ifndef NO_PRAGMA_ONCE
#pragma once
#endif
 
#include "cXProtocol.h"
#include "GrayCore/include/cFileCopier.h"
 
namespace GrayLib
{
        class GRAYLIB_LINK cXProtocolClient
                : public cXProtocolBase
                , public cXProtocolRx
                , public cXProtocolTx
                , public IFileCopier
        {
 
        public:
                cPingClientQuery m_PingQuery;   
 
        protected:
                // Response to my last action/method invocation.
                // Server sends  client a challenge when connect is started.
                HRESULT on_Interfaces();                
                HRESULT on_InterfaceDef();                                      
                HRESULT on_Prop();                              
                HRESULT on_Props();                     
                HRESULT on_Invoke();                    
                HRESULT on_TagDef();
                HRESULT on_Tags();
                HRESULT on_Ping();
                HRESULT onSet_File();
 
                // Requested responses.
                virtual HRESULT onX_Error(HRESULT hResRet, const cVariant& vVal) override;
                virtual HRESULT onX_Interfaces(UID_t uid, BYTE bInterfaceQty, const SCRIPTINTERFACEID_t* pbInterfaces);
                virtual HRESULT onX_InterfaceDef(cScriptableInterfaceDynamic* pInterfaceDef);
                virtual HRESULT onX_Invoke(UID_t uid, SCRIPTINTERFACEID_t bInterfaceID, SCRIPTPROPID_t bPropIndex, const cVariant& vVal);
                virtual HRESULT onX_TagDef(cScriptTagDef* pTagDef);
                virtual HRESULT onX_Tag(cXObject* pObj, ATOMCODE_t idTag, const cVariant& vVal);
                virtual HRESULT onX_Ping(TIMESYS_t dwTime, const char* pszName);
 
                virtual HRESULT ProcessStreamRxMsg() override;
 
        public:
                cXProtocolClient(cXProtocolDataMgr* pProtocolDataMgr, cStreamInput* pStreamRx, cStreamOutput* pStreamTx);
                virtual ~cXProtocolClient();
 
                virtual bool isClientSide() const override
                {
                        return true;
                }
                STDMETHOD_(PLEVEL_TYPE, get_PrivLevel)() const override
                {
                        return PLEVEL_Admin;
                }
                STDMETHOD_(cString, get_Name)() const override
                {
                        return _GT(GRAY_NAMES) _GT("Client");
                }
 
                void InitClient(cStreamInput* pStreamRx, cStreamOutput* pStreamTx);
 
                HRESULT Request_Error_Hello();
 
                // Request the types of interfaces supported by the object
                HRESULT Request_Interfaces(UID_t uid);
                HRESULT Request_Interfaces(cXObject* pObj);
 
                // What props and methods does this interface support.
                HRESULT Request_InterfaceDef(SCRIPTINTERFACEID_t bInterfaceID);
 
                // Request all the props in the interface.
                HRESULT Request_Props(UID_t uid, SCRIPTINTERFACEID_t bInterfaceID = SCRIPTINTERFACEID_MAX);
                HRESULT Request_Props(cXObject* pObj, SCRIPTINTERFACEID_t bInterfaceID = SCRIPTINTERFACEID_MAX);
                HRESULT Request_Props(cXObject* pObj, const cScriptableInterfaceDef* pInterface);
 
                // Request a specific interfaces property or props.
                HRESULT Request_Prop(UID_t uid, SCRIPTINTERFACEID_t bInterfaceID, SCRIPTPROPID_t bPropIndex);
                HRESULT Request_Prop(cXObject* pObj, const cScriptableProp* pProp);
                HRESULT Set_Prop(UID_t uid, SCRIPTINTERFACEID_t bInterfaceID, SCRIPTPROPID_t bPropIndex, const cVariant& vVal); // Client wants to set a prop on some object.
                HRESULT Set_Prop(cXObject* pObj, const cScriptableProp* pProp, const cVariant& vVal);
 
                // Object Tags
                HRESULT Request_TagDef(ATOMCODE_t idTag);
                HRESULT Set_TagDef(UID_t uid, cStringA sName, const cVariant& vVal);
                HRESULT Request_Tags(UID_t uid);
                HRESULT Set_Tag(UID_t uid, ATOMCODE_t idTag, const cVariant& vVal);
 
                // request to invoke a method on the server
                HRESULT Request_Invoke(UID_t uid, SCRIPTINTERFACEID_t bInterfaceID, SCRIPTPROPID_t bPropIndex, const cVariant& vValArgs);
                HRESULT Request_Invoke(cXObject* pObj, const cScriptableMethod* pMethod, const cVariant& vValArgs);
                HRESULT Request_Invoke(cXObject* pObj, const ATOMCHAR_t* pszMethod, const cVariant& vValArgs);
 
                HRESULT Request_Ping(TIMESYSD_t nTimeThrottle = cTimeSys::k_FREQ * 10);
 
                // IFileCopier
                virtual cStringA get_ConnectName() const override;
                virtual HRESULT RequestFile(const FILECHAR_t* pszSrcName, const FILECHAR_t* pszDesPath, IStreamProgressCallback* pProgress, FILE_SIZE_t nOffsetStart = 0, FILE_SIZE_t* pnRequestSizeEst = nullptr) override;
                virtual HRESULT SendFile(const FILECHAR_t* pszSrcPath, const FILECHAR_t* pszDestName, IStreamProgressCallback* pProgress, FILE_SIZE_t nOffsetStart = 0, FILE_SIZE_t nSize = (FILE_SIZE_t)-1) override;
        };
};
#endif