GloOrderMsg.h

Go to the documentation of this file.

#ifndef INC_GLOORDERMSG_H
#define INC_GLOORDERMSG_H
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
#include <string>
#include <map>
#include <vector>
#include <sstream>
#include "GloTypes.h"
#include "GloCommunicator.h"
#include "EuBlob.h"
//-----------------------------------------------------------------------------
namespace glo
{
  //---------------------------------------------------------------------------
  /* Forwards */
  class ClassInfo;
  //---------------------------------------------------------------------------
  #ifdef _MSC_VER
    /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
    #pragma warning( disable : 4251 )
  #endif
  //---------------------------------------------------------------------------
  class __glo_export_dll OrderMsg
  {
    //============== Friends
    //-------------------------------------------------------------------------
    friend class CommunicaterThread;
    //-------------------------------------------------------------------------
 
    public:
      //============== Enums
      //-----------------------------------------------------------------------
      enum EnOrderType 
      {
        //---------------------------------------------------------------------
        eUNDEF = 0,
        //---------------------------------------------------------------------
        eGET_ALL_BASES,
        //---------------------------------------------------------------------
        eGET_CLASSINFO_BY_CLASSID,
        //---------------------------------------------------------------------
        eGET_CLASSINFO_BY_CLASSNAME,
        //---------------------------------------------------------------------
        eGET_ALL_DEFAULT_LIMITS,
        //---------------------------------------------------------------------
        eGET_DATATYPE_LIMITS,
        //---------------------------------------------------------------------
        eGET_SUBCLASS_INFOS,
        //---------------------------------------------------------------------
        eGET_BASECLASS_INFOS,
        //---------------------------------------------------------------------
        eGET_ALL_SUBCLASS_INFOS,
        //---------------------------------------------------------------------
        eGET_ALL_BASECLASS_INFOS,
        //---------------------------------------------------------------------
        eGET_ALL_CLASS_INFOS,
        //---------------------------------------------------------------------
        eIS_KNOWN_CLASSID,
        //---------------------------------------------------------------------
        eIS_SUPER_CLASS_FROM,
        //---------------------------------------------------------------------
        eGET_ALL_CLIENTS,
        //---------------------------------------------------------------------
        eOPEN_BASE,
        //---------------------------------------------------------------------
        eCLOSE_BASE,
        //---------------------------------------------------------------------
        eASSIGN,
        //---------------------------------------------------------------------
        eOPEN_ALLSET,
        //---------------------------------------------------------------------
        eCLOSE_ALLSET,
        //---------------------------------------------------------------------
        eGET_OBJID_WITH_OBJECT_FROM_ALLSET,
        //---------------------------------------------------------------------
        eGET_OBJID_FROM_ALLSET,
        //---------------------------------------------------------------------
        eSET_INDEX_FILTER_BY_SEARCHVALUE_IN_ALLSET,
        //---------------------------------------------------------------------
        eSET_INDEX_FILTER_BY_COMPARING_IN_ALLSET,
        //---------------------------------------------------------------------
        eSET_INDEX_FILTER_BY_RANGE_IN_ALLSET,
        //---------------------------------------------------------------------
        eREMOVE_INDEX_FILTER,
        //---------------------------------------------------------------------
        eGET_INDEXED_OBJIDS_BY_SEARCHVALUE_FROM_ALLSET,
        //---------------------------------------------------------------------
        eGET_INDEXED_OBJIDS_BY_COMPARING_FROM_ALLSET,
        //---------------------------------------------------------------------
        eGET_INDEXED_OBJIDS_BY_RANGE_FROM_ALLSET,
        //---------------------------------------------------------------------
        eGET_ALLSET_SIZE,
        //---------------------------------------------------------------------
        eSET_CURRENT_OBJECT_IN_ALLSET,
        //---------------------------------------------------------------------
        eSET_POSITION_IN_ALLSET,
        //---------------------------------------------------------------------
        eCHECK_OBJID_IN_ALLSET,
        //---------------------------------------------------------------------
        eGET,
        //---------------------------------------------------------------------
        eGET_REC,
        //---------------------------------------------------------------------
        eREFRESH,
        //---------------------------------------------------------------------
        eSTORE,
        //---------------------------------------------------------------------
        eIS_STORED,
        //---------------------------------------------------------------------
        eDELETE,
        //---------------------------------------------------------------------
        eDELETE_MULTIPLE,
        //---------------------------------------------------------------------
        eLOCK,
        //---------------------------------------------------------------------
        eLOCK_REFRESH,
        //---------------------------------------------------------------------
        eRELOCK,
        //---------------------------------------------------------------------
        eRELOCK_REFRESH,
        //---------------------------------------------------------------------
        eUNLOCK,
        //---------------------------------------------------------------------
        eIS_LOCKED,
        //---------------------------------------------------------------------
        eIS_ALLOWED,
        //---------------------------------------------------------------------
        eGET_PROCESSING_POSSIBILITIES,
        //---------------------------------------------------------------------
        eWATCH_OBJECT,
        //---------------------------------------------------------------------
        eUNWATCH_OBJECT,
        //---------------------------------------------------------------------
        eWATCH_CLASS,
        //---------------------------------------------------------------------
        eUNWATCH_CLASS,
        //---------------------------------------------------------------------
        eWATCH_CLIENT,
        //---------------------------------------------------------------------
        eUNWATCH_CLIENT,
        //---------------------------------------------------------------------
        eWATCH_INDEX_READWRITE,
        //---------------------------------------------------------------------
        eUNWATCH_INDEX_READWRITE,
        //---------------------------------------------------------------------
        eBEGIN_TRANSACTION,
        //---------------------------------------------------------------------
        eCOMMIT_TRANSACTION,
        //---------------------------------------------------------------------
        eABORT_TRANSACTION,
        //---------------------------------------------------------------------
        ePROCESS_TRANSACTION,
        //---------------------------------------------------------------------
        eREINDEX_BASE,
        //---------------------------------------------------------------------
        eCOMPRESS_BASE,
        //---------------------------------------------------------------------
        eREPAIR_BASE,
        //---------------------------------------------------------------------
        eNOTIFY_CLIENT,
        //---------------------------------------------------------------------
        eNOTIFY_OBJECT_AS_WRITTEN,
        //---------------------------------------------------------------------
        ePROCESS_NOTIFY,
        //---------------------------------------------------------------------
        eDELETE_COMMUNICATOR_WATCHES,
        //---------------------------------------------------------------------
        eNEW_CONNECTED_CLIENT,
        //---------------------------------------------------------------------
        eDISCONNECTED_CLIENT
        //---------------------------------------------------------------------
      };
      //-----------------------------------------------------------------------
      enum EnStreamOrderDataType
      {
        eORDERDATA,   
        eRESULTDATA   
      };
      //-----------------------------------------------------------------------
      enum EnSendDirection
      {
        eTO_CLIENT_ANSWER,  
        eTO_CLIENT_NOTIFY,  
        eTO_SERVER,         
        eINTERN             
      };
      //-----------------------------------------------------------------------
 
    private:
      //============== Enums
      //-----------------------------------------------------------------------
      enum EnStreamDataType 
      {
        eUNDEF_DATATYPE = 0,              
        eALLSET_ITER_RESULT,              
        eALLSET_STRUCT,                   
        eBOOL,                            
        eCLASSINFO,                       
        eCLASSINFO_MAP,                   
        eCLIENTINFO_VECTOR,               
        eCLIENTONFO,                      
        eCOMPARISION_QUERRY_STRUCT,       
        eDATATYPE,                        
        eDATATYPELIMITS,                  
        eDATATYPELIMITS_VECTOR,           
        eFLOAT,                           
        eLOCKSPEC_STRUCT,                 
        eNOTIFYNOTE_STRUCT,               
        eOBJID,                           
        eOBJID_LIST,                      
        eOBJID_VECTOR,                    
        eOPENSPEC_STRUCT,                 
        eQUERRY_STRUCT,                   
        eRANGE_QUERRY_STRUCT,             
        eRECORD,                          
        eRECORD_LIST,                     
        eRECORD_MAP,                      
        eSIGNED,                          
        eSTRING,                          
        eSTRING_VECTOR,                   
        eUNSIGNED_INT,                    
        eUNSIGNED_INTPTR,                 
        eUNSIGNED_LONG,                   
        eUNSIGNED_SIZE,                   
        eWATCHSPEC_STRUCT                 
      };
      //-----------------------------------------------------------------------
 
    private:
      //============== Attribute
      //-----------------------------------------------------------------------
      std::string m_sSchemaName;
      //-----------------------------------------------------------------------
      unsigned int m_uiID;
      //-----------------------------------------------------------------------
      int m_iErr;
      //-----------------------------------------------------------------------
      Communicator * m_pCommunicator;
      //-----------------------------------------------------------------------
      std::string m_sCommunicatorClientName;
      //-----------------------------------------------------------------------
      unsigned int m_uiCommunicatorID;
      //-----------------------------------------------------------------------
      NUM_PTR m_ipThreadID;
      //-----------------------------------------------------------------------
      OrderMsg::EnOrderType m_eOrderType;
      //-----------------------------------------------------------------------
      void * m_pOrderObject;
      //-----------------------------------------------------------------------
      bool m_bDestroyOrderObject;
      //-----------------------------------------------------------------------
      bool m_bOrderObjectModified;
      //-----------------------------------------------------------------------
      void * m_pOrderResult;
      //-----------------------------------------------------------------------
      bool m_bProcessed;
      //-----------------------------------------------------------------------
      void * m_pFirstAdditionalInfo;
      //-----------------------------------------------------------------------
      bool m_bFirstAdditionalInfoModified;
      //-----------------------------------------------------------------------
      void * m_pSecondAdditionalInfo;
      //-----------------------------------------------------------------------
      bool m_bSecondAdditionalInfoModified;
      //-----------------------------------------------------------------------
      OrderMsg::EnSendDirection m_eDirection;
      //-----------------------------------------------------------------------
 
    #ifdef _DEBUG
    public:
      //============== Attribute
      //-----------------------------------------------------------------------
      std::string m_strStatus;
      //-----------------------------------------------------------------------
    #endif
 
    protected:
      //============== Konstruktoren
      //-----------------------------------------------------------------------
      OrderMsg();
      //-----------------------------------------------------------------------
 
    public:
      //============== De- und Konstruktoren
      //-----------------------------------------------------------------------
      OrderMsg( const std::string & rsSchemaName,
                Communicator * pCommunicator,
                EnOrderType eOrderType,
                void * pOrderObject,
                void * pOrderResult,
                void * pFirstAdditionalInfo = nullptr,
                void * pSecondAdditionalInfo = nullptr );
      //-----------------------------------------------------------------------
      OrderMsg( const std::string & rsSchemaName,
                EnOrderType eOrderType,
                void * pOrderObject,
                void * pFirstAdditionalInfo = nullptr,
                void * pSecondAdditionalInfo = nullptr );
      //-----------------------------------------------------------------------
      OrderMsg( const eut::Blob & rBlob,
                EnStreamOrderDataType eStreamDataType,
                const std::map< unsigned long, ClassInfo * > * pSchemaInfoMap );
      //-----------------------------------------------------------------------
      virtual ~OrderMsg();
      //-----------------------------------------------------------------------
 
    private:
      //============== Konstruktoren
      //-----------------------------------------------------------------------
      OrderMsg( const OrderMsg & );
      //-----------------------------------------------------------------------
 
    public:
      //============== Methoden
      //-----------------------------------------------------------------------
      void setSendDirection( EnSendDirection eSendDirection );
      //-----------------------------------------------------------------------
      OrderMsg::EnSendDirection getSendDirection() const;
      //-----------------------------------------------------------------------
      void setCommunicator( Communicator * pCommunicator );
      //-----------------------------------------------------------------------
      Communicator * getCommunicator() const;
      //-----------------------------------------------------------------------
      std::string getCommunicatorClientName() const;
      //-----------------------------------------------------------------------
      unsigned int getCommunicatorID() const;
      //-----------------------------------------------------------------------
      void setThreadID( NUM_PTR ipThreadID );
      //-----------------------------------------------------------------------
      NUM_PTR getThreadID() const;
      //-----------------------------------------------------------------------
      void setOrderType( OrderMsg::EnOrderType eOrderType );
      //-----------------------------------------------------------------------
      OrderMsg::EnOrderType getOrderType() const;
      //-----------------------------------------------------------------------
      std::string getOrderTypeAsStr() const;
      //-----------------------------------------------------------------------
      void setFirstAdditionalInfo( void * pFirstAdditionalInfo );
      //-----------------------------------------------------------------------
      void * getFirstAdditionalInfo() const;
      //-----------------------------------------------------------------------
      void deleteFirstAdditionalInfo();
      //-----------------------------------------------------------------------
      void setSecondAdditionalInfo( void * pSecondAdditionalInfo );
      //-----------------------------------------------------------------------
      void * getSecondAdditionalInfo() const;
      //-----------------------------------------------------------------------
      void deleteSecondAdditionalInfo();
      //-----------------------------------------------------------------------
      void setOrderObject( void * pOrderObject );
      //-----------------------------------------------------------------------
      void * getOrderObject() const;
      //-----------------------------------------------------------------------
      void deleteOrderObject();
      //-----------------------------------------------------------------------
      bool willDestroyOrderObjectInDTor() const;
      //-----------------------------------------------------------------------
      void setOrderResult( void * pOrderResult );
      //-----------------------------------------------------------------------
      void * getOrderResult() const;
      //-----------------------------------------------------------------------
      void * ReleaseOrderResult();
      //-----------------------------------------------------------------------
      void deleteOrderResult();
      //-----------------------------------------------------------------------
      void setOrderMsgID( unsigned int uiID );
      //-----------------------------------------------------------------------
      unsigned int getOrderMsgID() const;
      //-----------------------------------------------------------------------
      void setErr( int iErr );
      //-----------------------------------------------------------------------
      int getErr() const;
      //-----------------------------------------------------------------------
      std::string getSchemaName() const;
      //-----------------------------------------------------------------------
      bool isProcessed();
      //-----------------------------------------------------------------------
      void streamOrderInBlob( eut::Blob & rBlob,
                              EnStreamOrderDataType eStreamOrderDataType ) const;
      //-----------------------------------------------------------------------
      int streamBlobInOrder( const eut::Blob & rBlob,
                             EnStreamOrderDataType eStreamOrderDataType,
                             const std::map< unsigned long, ClassInfo * > * pSchemaInfoMap );
      //-----------------------------------------------------------------------
 
      //========== static Methoden =========
      //-----------------------------------------------------------------------
      static std::string getOrderTypeAsString( EnOrderType eOrderType );
      //-----------------------------------------------------------------------
 
    protected:
      //============== Methoden
      //-----------------------------------------------------------------------
      void deleteFirstAdditionalInfo( OrderMsg::EnOrderType eOrderType );
      //-----------------------------------------------------------------------
      void deleteSecondAdditionalInfo( OrderMsg::EnOrderType eOrderType );
      //-----------------------------------------------------------------------
      void deleteOrderObject( OrderMsg::EnOrderType eOrderType );
      //-----------------------------------------------------------------------
      void deleteOrderResult( OrderMsg::EnOrderType eOrderType );
      //-----------------------------------------------------------------------
      template<typename T> int addStreamData0terminated( eut::Blob & rBlob, const T tData ) const;
      //-----------------------------------------------------------------------
      int addStreamDataType( eut::Blob & rBlob,
                             void * pData,
                             EnStreamDataType eStreamDataType,
                             std::map< ObjID, ObjID, std::less<ObjID> > & rReadyRecordMap ) const;
      //-----------------------------------------------------------------------
      int setDataFromStream( const eut::Blob & rBlob,
                             std::size_t & rnCurrentBlobPosition,
                             std::size_t & rnBlobPosition,
                             void *& prData,
                             EnStreamDataType eStreamDataType,
                             const std::map< unsigned long, ClassInfo * > * pSchemaInfoMap );
      //-----------------------------------------------------------------------
 
    public:
      //============== Methoden
      //------------------------------------------------------------------------
      #ifdef _DEBUG
      virtual std::string toString() const;
      #endif
      //-----------------------------------------------------------------------
 
    private:
      //============== Operatoren
      //-----------------------------------------------------------------------
      OrderMsg & operator= ( const OrderMsg & );
      //-----------------------------------------------------------------------
  };
  //---------------------------------------------------------------------------
  template<typename T> int OrderMsg::addStreamData0terminated( eut::Blob & rBlob, const T tData ) const
  {
    int                   t_iErr = 0;
    std::ostringstream    t_ossConverter;
 
    t_ossConverter << tData;
    t_iErr = rBlob.append( t_ossConverter.str().c_str(), t_ossConverter.str().size() );
    if ( ! t_iErr ) t_iErr = rBlob.append( "\0", 1 );
    return t_iErr;
  }
  //---------------------------------------------------------------------------
  #ifdef _MSC_VER
    /* 'Bezeichner': Klasse 'Typ' benötigt eine DLL-Schnittstelle, die von... */
    #pragma warning( default : 4251 )
  #endif
  //---------------------------------------------------------------------------
} // namespace glo
#endif