CigiMessage.h

Go to the documentation of this file.

#if !defined(_CIGI_MESSAGE_INCLUDED_)
#define _CIGI_MESSAGE_INCLUDED_

#include <list>

#include "CigiAnimationTable.h"
#include "CigiHoldEnvCtrl.h"
#include "CigiMessageBuffer.h"

class CigiSession;

using namespace std;

//=========================================================
class CIGI_SPEC CigiMessage  
{
public:

friend class CigiSession;


   //==> Management

   //=========================================================
        CigiMessage();

   //=========================================================
        virtual ~CigiMessage();


   //==> Public Accessor functions

   //=========================================================
    bool GetValidIGCtrlSOF()
    {
       bool Rslt = false;
       if(CrntMsgBuf != NULL)
          Rslt = CrntMsgBuf->IsValidIGCtrlSOF();

       return(Rslt);
    }


   //==> Processing Member functions
   
   //=========================================================
        int CreateBuffer(const int NumBuf = 2, const int BufLen = 16384);


protected:

   //==> Member variables

   //=========================================================
   list<CigiMessageBuffer *> Buffers;

   //=========================================================
   list<CigiMessageBuffer *> AvailBuff;

   //=========================================================
   CigiMessageBuffer *CrntMsgBuf;

   //=========================================================
   CigiMessageBuffer *CrntFillBuf;

   //=========================================================
   CigiMessageBuffer *PackagedMsg;

   //=========================================================
        int BufferSize;

   //=========================================================
   CigiAnimationTable *ATbl;

   //=========================================================
   CigiHoldEnvCtrl EnvHoldObj;

   //=========================================================
   CigiSession *Session;


   //==> Member Protected Functions


   //=========================================================
   void SetAnimationTable(CigiAnimationTable *AnimationTable) { ATbl = AnimationTable; }


   //=========================================================
   void SetSession(CigiSession *SessionIn) { Session = SessionIn; }

};

#endif // !defined(_CIGI_MESSAGE_INCLUDED_)

---