---

packetmessageque.h

Go to the documentation of this file.

/********************************************************************
       Copyright (c) 2001, Lee Patterson & Ant Works Software
       http://ssobjects.sourceforge.net

       filename :  packetmessageque.h
       author   :  Lee Patterson (lee@antws.com)

       purpose  :  This que is used to hold incoming messages. Each message
                   contains a pointer to the incoming packet, and a pointer to
                   the socket that input came from. Output will normally be 
                   sent to this socket.
*********************************************************************/

#ifndef PACKETMESSAGEQUE_H
#define PACKETMESSAGEQUE_H

#include "mcl.h"
#include "generalexception.h"
#include "packetbuffer.h"
#include "threadutils.h"
#include "socketinstance.h"
#include "linkedlist.h"

#define throwPacketMessageException(m) (throw PacketMessageException(m,__FILE__,__LINE__))


namespace ssobjects
{

class PacketMessageException : public GeneralException
{
  public: // Constructor/destructor
    PacketMessageException(char* pchMessage,const char* pFname,const int iLine) 
      : GeneralException(pchMessage,pFname,iLine){};
};

class PacketMessage
{
  public:             //constructor / deconstructor
    PacketMessage(SocketInstance* const s,PacketBuffer* const p);
    virtual ~PacketMessage();

  public:             //functions
    PacketBuffer*         packet() const      
    {return m_pPacket;}
    
    SocketInstance*       socket() const      
    {return m_pSocket;}
    
    uint                  id()     const      

    {return m_nID;}

  private:            //thread data and methods
    static unsigned32 m_nUniqueID;
    static Lock       m_lockID;
    unsigned32        uniqueID();

   private:            //regular data
    unsigned32              m_nID;
    bool                    m_bUsed;
    SocketInstance*         m_pSocket;
    PacketBuffer*           m_pPacket;

  private:
    //unused overloads
    PacketMessage(const PacketMessage&);
    PacketMessage& operator=(const PacketMessage&);
};

#define throwPacketMessageQueException(m) (throw PacketMessageQueException(m,__FILE__,__LINE__))

class MsgQueException : public GeneralException
{
  public: // Constructor/destructor
    MsgQueException(char* pchMessage,const char* pFname,const int iLine) 
      : GeneralException(pchMessage,pFname,iLine){};
};


class PacketMessageQue 
{
  private:
    bool            m_bSetEvents; 
    LinkedList<PacketMessage>   m_listMsgs;   
    Lock            m_lock;       
    Event           m_event;      

  public:
    PacketMessageQue(bool bSetEvents=true);
    virtual ~PacketMessageQue();

  public:
    void            add(PacketMessage *);   
    PacketMessage*          get();          
    bool            isEmpty();      
    void            purge();        
#if 0
    //not tested
    bool            signal();
    bool            reset();
    bool            pulse();
    unsigned32      wait(uint nMilliseconds=INFINITE);
#endif
  private:
    //unused overloads
    PacketMessageQue(const PacketMessageQue&);
    PacketMessageQue& operator=(const PacketMessageQue&);
};

};
#endif

---